Struct IpcRpcBuilder

pub struct IpcRpcBuilder<U: UserMessage> { /* private fields */ }

Builds an IpcRpc. This is initialized via IpcRpc::build()

Implementations

impl<U: UserMessage> IpcRpcBuilder<U>

pub fn env<K: Into<OsString>, V: Into<OsString>>( &mut self, key: K, value: V, ) -> &mut Self

Additional environment variable to pass in to the new client.

pub fn envs<K: Into<OsString>, V: Into<OsString>, I: Iterator<Item = (K, V)>>( &mut self, iter: I, ) -> &mut Self

Additional environment variables to pass in to the new client.

pub fn current_dir<P: Into<PathBuf>>(&mut self, path: P) -> &mut Self

Sets the current directory for the new client process

pub async fn finish<SE, F, Fut, A>( &mut self, path_to_exe: SE, message_handler: F, arguments_fn: A, ) -> Result<IpcRpc<U>, IpcRpcError>

where SE: AsRef<OsStr>, F: Fn(U) -> Fut + Send + Sync + 'static, Fut: Future<Output = Option<U>> + Send, A: FnOnce(ConnectionKey, &mut Command),

Initializes a server and client, connects the two, then returns a combination structure which can be used for the server side of the relationship.

• path_to_exe: The path to the exe which is expected to connect to the server on startup
• message_handler: A function for handling spontaneous messages from the new client
• arguments_fn: This method MUST provide the server connect key to the client. The easiest way to do this is to pass in the key as a command line argument. The client must be prepared to read the key from wherever this function puts it.

Trait Implementations

impl<U: Clone + UserMessage> Clone for IpcRpcBuilder<U>

fn clone(&self) -> IpcRpcBuilder<U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U: Debug + UserMessage> Debug for IpcRpcBuilder<U>

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

Formats the value using the given formatter.

impl<U: UserMessage> Default for IpcRpcBuilder<U>

fn default() -> Self

Returns the “default value” for a type.