Struct JsCommunicationBackend 

pub struct JsCommunicationBackend {
    sender: Arc<ThreadBoundRunner<JsCommunicationBackendSender>>,
    receive_rx: Receiver<IncomingMessage>,
    receive_tx: Sender<IncomingMessage>,
}

JavaScript implementation of the CommunicationBackend trait for IPC communication.

Fields

sender: Arc<ThreadBoundRunner<JsCommunicationBackendSender>>

receive_rx: Receiver<IncomingMessage>

receive_tx: Sender<IncomingMessage>

Implementations

impl JsCommunicationBackend

pub fn new(sender: JsCommunicationBackendSender) -> JsCommunicationBackend

Creates a new instance of the JavaScript communication backend.

pub fn receive(&self, message: IncomingMessage) -> Result<(), JsValue>

Used by JavaScript to provide an incoming message to the IPC framework.

Trait Implementations

impl Clone for JsCommunicationBackend

fn clone(&self) -> JsCommunicationBackend

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommunicationBackend for JsCommunicationBackend

type SendError = WasmCommunicationError

Error returned by send, classified via [IpcErrorKind].

type Receiver = RwLock<Receiver<IncomingMessage>>

Receiver type returned by subscribe.

async fn send( &self, message: OutgoingMessage, ) -> Result<(), <JsCommunicationBackend as CommunicationBackend>::SendError>

Send a message to the destination specified in the message. This function may be called from any thread at any time.

async fn resolve(&self, group: &BroadcastGroup) -> BroadcastResolution

Resolve a [BroadcastGroup] into the endpoints that are currently its members. Called by IpcClient::broadcast, which rejects any resolved endpoint that falls outside the group.

async fn subscribe( &self, ) -> <JsCommunicationBackend as CommunicationBackend>::Receiver

Subscribe to receive messages. This function will return a receiver that can be used to receive messages asynchronously.

impl FromWasm for JsCommunicationBackend

Available on crate feature wasm only.

type Wire = JsCommunicationBackend

The type JavaScript actually passes.

fn from_wire( wire: <JsCommunicationBackend as FromWasm>::Wire, ) -> Result<JsCommunicationBackend, WireError>

Recovers the Rust value from the wire value.

impl FromWasmAbi for JsCommunicationBackend

type Abi = WasmPtr<WasmRefCell<JsCommunicationBackend>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi( js: <JsCommunicationBackend as FromWasmAbi>::Abi, ) -> JsCommunicationBackend

Recover a Self from Self::Abi.

impl IntoWasmAbi for JsCommunicationBackend

type Abi = WasmPtr<WasmRefCell<JsCommunicationBackend>>

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> <JsCommunicationBackend as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for JsCommunicationBackend

type Abi = WasmPtr<WasmRefCell<JsCommunicationBackend>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsCommunicationBackend>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <JsCommunicationBackend as LongRefFromWasmAbi>::Abi, ) -> <JsCommunicationBackend as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl NullableFromWasmAbi for JsCommunicationBackend

fn is_null(abi: &<JsCommunicationBackend as MaybeFromWasmAbi>::MaybeAbi) -> bool

Tests the ABI value for Nullable::Null.

impl NullableIntoWasmAbi for JsCommunicationBackend

fn null() -> <JsCommunicationBackend as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl OptionFromWasmAbi for JsCommunicationBackend

fn is_none(abi: &<JsCommunicationBackend as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for JsCommunicationBackend

fn none() -> <JsCommunicationBackend as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for JsCommunicationBackend

type Abi = WasmPtr<WasmRefCell<JsCommunicationBackend>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsCommunicationBackend>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <JsCommunicationBackend as RefFromWasmAbi>::Abi, ) -> <JsCommunicationBackend as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for JsCommunicationBackend

type Abi = WasmPtr<WasmRefCell<JsCommunicationBackend>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsCommunicationBackend>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <JsCommunicationBackend as RefMutFromWasmAbi>::Abi, ) -> <JsCommunicationBackend as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl ToWasm for JsCommunicationBackend

Available on crate feature wasm only.

type Wire = JsCommunicationBackend

The type JavaScript actually receives.

fn to_wire(self) -> Result<<JsCommunicationBackend as ToWasm>::Wire, WireError>

Converts the Rust value into the wire value.

impl TryFromJsValue for JsCommunicationBackend

fn try_from_js_value(value: JsValue) -> Result<JsCommunicationBackend, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<JsCommunicationBackend>

Performs the conversion.

const NULLABLE: bool = false

Whether Self accepts null as a distinct value space, as Nullable<T> does. An enclosing Option then passes null through instead of reading it as None, so Option<T> is itself nullable exactly when T is not. JsValue does not set this: it accepts null as one value among all of them, not as a distinct space, and Option<JsValue> reads it as None like the ABI does. This is the JS-value side of NullableFromWasmAbi, which claims null at the ABI.

impl VectorFromWasmAbi for JsCommunicationBackend

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <JsCommunicationBackend as VectorFromWasmAbi>::Abi, ) -> Box<[JsCommunicationBackend]>

impl VectorIntoWasmAbi for JsCommunicationBackend

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[JsCommunicationBackend]>, ) -> <JsCommunicationBackend as VectorIntoWasmAbi>::Abi