Struct NodeBridge

Source
pub struct NodeBridge { /* private fields */ }
Expand description

The Bridge between node and rust.

Implementations§

Source§

impl NodeBridge

Source

pub fn new() -> NodeBridge

Creates a bridge between node and rust. There can be only 1 bridge per rust program.

Source

pub fn send<T: ToString, F: ToString>( &self, channel_name: T, data: F, ) -> Result<(), BridgeClosedError>

Sends a message through a channel to node. Results with an Err(BridgeClosedError) if the bridge is already closed.

assert_eq!(bridge.send("channel_foo", "bar"), Ok(()));
bridge.close().await;
assert_eq!(bridge.send("channel_foo", "bar"), Err(BridgeClosedError));
Source

pub async fn wait_until_closes(&self)

Waits until the bridge is closed in some way to prevent it from closing on its own.

Source

pub fn is_closed(&self) -> bool

Returns whether the bridge is closed or not.

Source

pub async fn close(&self)

Closes the bridge and waits until its close.

Source

pub async fn receive<T: ToString>( &self, channel_name: T, ) -> Result<String, BridgeClosedError>

Receives a message through a channel from node. Results with an Err(BridgeClosedError) if the bridge is already closed.

bridge.receive("channel_foo").await.unwrap();
bridge.close().await;
assert_eq!(bridge.receive("channel_foo").await, Err(BridgeClosedError));
Source

pub fn register<T: ToString + 'static, D: Send + 'static + Clone, B: FromStr + 'static>( &self, name: &str, function: fn(Vec<B>, Option<D>) -> T, pass_data: Option<D>, )
where <B as FromStr>::Err: Debug,

Registers a sync function that can be called from node as long as the bridge is not closed.

Source

pub fn register_async<T: ToString, F, D>( &self, name: &str, function: F, pass_data: Option<D>, )
where F: AsyncFn2<Vec<String>, Option<D>, Output = T> + Send + Sync + 'static, <F as AsyncFn2<Vec<String>, Option<D>>>::OutputFuture: Send, D: Send + Clone + 'static,

Registers an async function that can be called from node as long as the bridge is not closed.

Trait Implementations§

Source§

impl Clone for NodeBridge

Source§

fn clone(&self) -> NodeBridge

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.