Struct Descriptor

pub struct Descriptor { /* private fields */ }

A descriptor is used to connect to a service.

Implementations

impl Descriptor

pub fn new( ctx: &Context, rendezvous: PathBuf, executable: PathBuf, factory: HandlerFactory, ) -> Self

Create a descriptor given its rendez-vous point, the path to the servers executable file, and a handler factory.

pub fn context(&self) -> &Context

Returns the context.

pub fn rendez_vous(&self) -> &Path

Returns the rendez-vous point.

pub fn connect(&self) -> Result<RpcSystem<Side>>

Connects to a descriptor, starting the server if necessary.

Panic

This will panic if called outside of the Tokio runtime context. See See Handle::enter for more details.

pub fn connect_with_policy(&self, policy: IPCPolicy) -> Result<RpcSystem<Side>>

Connects to a descriptor, starting the server if necessary.

This function does not use the context’s IPC policy, but uses the given one.

Panic

This will panic if called outside of the Tokio runtime context. See See Handle::enter for more details.

pub fn bootstrap(&mut self) -> Result<Option<JoinHandle<Result<()>>>>

Turn this process into a server.

This checks if a server is running. If not, it turns the current process into a server.

This function is for servers trying to start themselves. Normally, servers are started by clients on demand. A client should never call this function.

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.