Struct rmp_ipc::IPCBuilder[][src]

pub struct IPCBuilder { /* fields omitted */ }
Expand description

A builder for the IPC server or client.

use rmp_ipc::IPCBuilder;
IPCBuilder::new()
    .address("127.0.0.1:2020")
   // register callback
    .on("ping", |_ctx, _event| Box::pin(async move {
        println!("Received ping event.");
        Ok(())
    }))
    // can also be build_client which would return an emitter for events
    .build_server().await.unwrap();

Implementations

impl IPCBuilder[src]

pub fn new() -> Self[src]

pub fn on<F: 'static>(self, event: &str, callback: F) -> Self where
    F: for<'a> Fn(&'a Context, Event) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>> + Send + Sync
[src]

Adds an event callback

pub fn address<S: ToString>(self, address: S) -> Self[src]

Adds the address to connect to

pub async fn build_server(self) -> Result<()>[src]

Builds an ipc server

pub async fn build_client(self) -> Result<Context>[src]

Builds an ipc client

Trait Implementations

impl Clone for IPCBuilder[src]

fn clone(&self) -> IPCBuilder[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.