adapter

Crates.ioadapter
lib.rsadapter
version0.3.1
sourcesrc
created_at2024-07-17 22:00:17.456717
updated_at2024-07-24 23:22:02.54906
descriptionAdapter provides a generic interface for plugins to interact with a host application.
homepagehttps://github.com/sjcobb2022/adapter
repositoryhttps://github.com/sjcobb2022/adapter
max_upload_size
id1306638
size117,182
Samuel Cobb (sjcobb2022)

documentation

README

Adapter

[!WARNING]
This library is in no way production ready.

Adapter is a library meant for providing a standard interface for which one can communicate with a variety of interfaces or plugins. It was created from a desire to be able to configure programs with a variety of different languages.

To see the thought process behind this, see RAMBLINGS.md.

The key concept of this library is the Adapter trait. It hinges on the idea that communicating with a foreign interface should be as simple as a function that has an input and an output. We use an identifier to determine the "endpoint" that we want to access.

pub trait Adapter<'a, Input, Output, Identifier> {
    type Error;

    fn call(&'a mut self, identifier: Identifier, input: Input) -> Result<Output, Self::Error>;
}

An adapter is generic over the input, output, identifier and error that is uses. It takes in an identifier and an input, and returns a result with the output or an error. By being generic, we can require stricter traits be applied to our inputs and outputs.

Commit count: 0

cargo fmt