Skip to main content

Connect

Struct Connect 

Source
pub struct Connect<C>
where C: IpcConnection,
{ pub endpoint: String, pub session_label: Option<String>, /* private fields */ }
Expand description

A command which is used to actively connect to another node like a client.

A new session will be created if the operation is successful. The user can provide a session_label as an alias to the session, and it can be used to refer to the session actor in other commands. If session_label is not provided, the endpoint of the connection will be used as the alias of the new session actor.

The command will return the address of the session actor if it succeeds.

Fields§

§endpoint: String§session_label: Option<String>

Implementations§

Source§

impl<C> Connect<C>
where C: IpcConnection,

Source

pub fn new<S1, S2>(endpoint: S1, label: S2) -> Self
where S1: AsRef<str>, S2: AsRef<str>,

Constructs a new Connect command for the connection type C.

Source

pub fn no_label<S>(endpoint: S) -> Self
where S: AsRef<str>,

Constructs a new Connect command for the connection type C without a session label.

Trait Implementations§

Source§

impl<C> Debug for Connect<C>
where C: IpcConnection,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Handler<Connect<T>> for Node
where T: IpcConnection,

Source§

type Result = Result<Address<Session>, NodeError>

The return type of the handler, which must implement MessageResponse.
Source§

async fn handle( &mut self, msg: Connect<T>, ctx: &mut Self::Context, ) -> Self::Result

Handles a message.
Source§

impl<C> Message for Connect<C>
where C: IpcConnection,

Source§

type Result = Result<Address<Session>, NodeError>

The type of the response produced when this message is handled.

Auto Trait Implementations§

§

impl<C> Freeze for Connect<C>

§

impl<C> RefUnwindSafe for Connect<C>

§

impl<C> Send for Connect<C>

§

impl<C> Sync for Connect<C>

§

impl<C> Unpin for Connect<C>

§

impl<C> UnsafeUnpin for Connect<C>

§

impl<C> UnwindSafe for Connect<C>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, M> FromEnvelope<A> for M
where A: Actor + Handler<M>, M: Message,

Source§

fn unpack(envelope: Envelope<A>) -> M

Unpacks the message from the envelope.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<A, M> IntoEnvelope<A> for M
where A: Actor + Handler<M>, M: Message,

Source§

fn pack(self, tx: Option<Sender<<M as Message>::Result>>) -> Envelope<A>

Packs the message and the optional response sender into an envelope.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more