Struct Bridge 

pub struct Bridge<A, F = BincodeFfiFormat>
where
    A: App,
    F: FfiFormat,
{ /* private fields */ }

Bridge is a core wrapper presenting the same interface as the Core but in a serialized form, using bincode as the serialization format.

Implementations

impl<A, Format> Bridge<A, Format>

where A: App, Format: FfiFormat,

pub fn new(core: Core<A>) -> Self

Create a new Bridge using the provided core.

pub fn process_event( &self, event: &[u8], ) -> Result<Vec<u8>, BridgeError<Format>>

where A::Event: for<'a> Deserialize<'a>, A::Effect: EffectFFI,

👎Deprecated since 0.17.0: Bridge API returning vectors has been deprecated. Please use the ‘update’ method.

Receive an event from the shell.

The event is serialized and will be deserialized by the core before it’s passed to your app.

Errors

Returns an error if the event could not be deserialized.

pub fn update<'a>( &self, event: &'a [u8], requests_out: &mut Vec<u8>, ) -> Result<(), BridgeError<Format>>

where A::Event: Deserialize<'a>, A::Effect: EffectFFI,

Send an event from the shell.

The event is serialized and will be deserialized by the core before it’s passed to your app.

Errors

Returns an error if the event could not be deserialized.

pub fn handle_response( &self, id: u32, output: &[u8], ) -> Result<Vec<u8>, BridgeError<Format>>

where A::Event: for<'a> Deserialize<'a>, A::Effect: EffectFFI,

👎Deprecated since 0.17.0: Bridge API returning vectors has been deprecated. Please use the ‘resolve’ method.

Receive a response to a capability request from the shell.

The output is serialized capability output. It will be deserialized by the core.

Errors

Returns an error if the response could not be deserialized.

Panics

The id MUST match the id of the effect that triggered it, else the core will panic.

pub fn resolve<'a>( &self, id: EffectId, response: &'a [u8], requests_out: &mut Vec<u8>, ) -> Result<(), BridgeError<Format>>

where A::Event: Deserialize<'a>, A::Effect: EffectFFI,

Provide a response to a capability request to resolve it and continue the corresponding command.

The output is serialized capability output. It will be deserialized by the core.

Errors

Returns an error if the response could not be deserialized.

Panics

The id MUST match the id of the effect that triggered it, else the core will panic.

pub fn view(&self, view_out: &mut Vec<u8>) -> Result<(), BridgeError<Format>>

where A::ViewModel: Serialize,

Get the current state of the app’s view model (serialized).

Errors

Returns an error if the view model could not be serialized.