Struct ClientEnd

pub struct ClientEnd<P, T = Channel> { /* private fields */ }

The client end of a protocol.

Implementations

impl<P, T> ClientEnd<P, T>

pub fn as_ref(&self) -> ClientEnd<P, &T>

Converts from &ClientEnd<P, T> to ClientEnd<P, &T>.

pub fn from_untyped(transport: T) -> ClientEnd<P, T>

Returns a new endpoint over the given transport.

pub fn into_untyped(self) -> T

Returns the underlying transport.

pub fn executor(&self) -> <T as HasExecutor>::Executor

where T: HasExecutor,

Returns the executor for the underlying transport.

impl<P, T> ClientEnd<P, T>

where T: Transport,

pub fn spawn_full_with_handler_on<H, E>( self, handler: H, executor: &E, ) -> (ClientSender<P, T>, <E as Executor>::Task<Result<H, ProtocolError<<T as Transport>::Error>>>)

where P: DispatchClientMessage<H, T>, T: 'static, H: Send + 'static, E: Executor,

Spawns a client for the given client end with a handler on an executor.

Returns the client sender and a join handle for the spawned task.

pub fn spawn_with_handler_on<H, E>( self, handler: H, executor: &E, ) -> ClientSender<P, T>

where P: DispatchClientMessage<H, T>, T: 'static, H: Send + 'static, E: Executor,

Spawns a client for the given client end with a handler on an executor.

Returns the client sender.

pub fn spawn_full_with_handler<H>( self, handler: H, ) -> (ClientSender<P, T>, <<T as HasExecutor>::Executor as Executor>::Task<Result<H, ProtocolError<<T as Transport>::Error>>>)

where P: DispatchClientMessage<H, T>, T: HasExecutor + 'static, H: Send + 'static,

Spawns a client for the given client end with a handler on the default executor for the transport.

Returns the client sender and a join handle for the spawned task.

pub fn spawn_with_handler<H>(self, handler: H) -> ClientSender<P, T>

where P: DispatchClientMessage<H, T>, T: HasExecutor + 'static, H: Send + 'static,

Spawns a client for the given client end with a handler on the default executor for the transport.

Returns the client sender.

pub fn spawn_full_on<E>( self, executor: &E, ) -> (ClientSender<P, T>, <E as Executor>::Task<Result<(), ProtocolError<<T as Transport>::Error>>>)

where P: 'static, T: 'static, E: Executor,

Spawns a client for the given client end on an executor.

The spawned client will ignore all incoming events. Returns the client sender and a join handle for the spawned task.

pub fn spawn_on<E>(self, executor: &E) -> ClientSender<P, T>

where P: 'static, T: 'static, E: Executor,

Spawns a client for the given client end on an executor.

The spawned client will ignore all incoming events. Returns the client sender.

pub fn spawn_full( self, ) -> (ClientSender<P, T>, <<T as HasExecutor>::Executor as Executor>::Task<Result<(), ProtocolError<<T as Transport>::Error>>>)

where P: 'static, T: HasExecutor + 'static,

Spawns a client for the given client end on the default executor for the transport.

The spawned client will ignore all incoming events. Returns the client sender and a join handle for the spawned task.

pub fn spawn(self) -> ClientSender<P, T>

where P: 'static, T: HasExecutor + 'static,

Spawns a client for the given client end on the default executor for the transport.

The spawned client will ignore all incoming events. Returns the client sender.

Trait Implementations

impl<P1, P2, T> CompatFrom<ClientEnd<P1>> for ClientEnd<P2, T>

where T: CompatFrom<Channel>, P2: CompatFrom<P1>,

fn compat_from(value: ClientEnd<P1>) -> ClientEnd<P2, T>

Converts value into a value of this type.

impl<P1, P2, T> CompatFrom<ClientEnd<P1, T>> for ClientEnd<P2>

where Channel: CompatFrom<T>, P2: CompatFrom<P1>,

fn compat_from(value: ClientEnd<P1, T>) -> ClientEnd<P2>

Converts value into a value of this type.

impl<P, T> Debug for ClientEnd<P, T>

where P: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<D, P, T> Decode<D> for ClientEnd<P, T>

where P: 'static, T: Decode<D>, D: ?Sized,

fn decode( slot: Slot<'_, ClientEnd<P, T>>, decoder: &mut D, ) -> Result<(), DecodeError>

Decodes a value into a slot using a decoder.

impl<P, T> Encodable for ClientEnd<P, T>

where T: Encodable, P: 'static,

type Encoded = ClientEnd<P, <T as Encodable>::Encoded>

The wire type for the value.

const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _

Whether the conversion from Self to Self::Encoded is equivalent to copying the raw bytes of Self.

impl<P, T> EncodableOption for ClientEnd<P, T>

where T: EncodableOption, P: 'static,

type EncodedOption = ClientEnd<P, <T as EncodableOption>::EncodedOption>

The wire type for the optional value.

impl<E, P, T> Encode<E> for ClientEnd<P, T>

where P: 'static, T: Encode<E>, E: ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<<ClientEnd<P, T> as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

impl<E, P, T> EncodeOption<E> for ClientEnd<P, T>

where P: 'static, T: EncodeOption<E>, E: ?Sized,

fn encode_option( this: Option<ClientEnd<P, T>>, encoder: &mut E, out: &mut MaybeUninit<<ClientEnd<P, T> as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E, P, T> EncodeOptionRef<E> for ClientEnd<P, T>

where P: 'static, T: EncodeOptionRef<E>, E: ?Sized,

fn encode_option_ref( this: Option<&ClientEnd<P, T>>, encoder: &mut E, out: &mut MaybeUninit<<ClientEnd<P, T> as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional reference into an encoder and output.

impl<E, P, T> EncodeRef<E> for ClientEnd<P, T>

where P: 'static, T: EncodeRef<E>, E: ?Sized,

fn encode_ref( &self, encoder: &mut E, out: &mut MaybeUninit<<ClientEnd<P, T> as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this reference into an encoder and output.

impl<P, T, U> FromWire<ClientEnd<P, U>> for ClientEnd<P, T>

where T: FromWire<U>,

fn from_wire(wire: ClientEnd<P, U>) -> ClientEnd<P, T>

Converts the given wire to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl<P, T, U> FromWireOption<ClientEnd<P, U>> for ClientEnd<P, T>

where P: 'static, T: FromWireOption<U>, U: Wire,

fn from_wire_option(wire: ClientEnd<P, U>) -> Option<ClientEnd<P, T>>

Converts the given wire to an option of this type.

impl<P, T, U> FromWireOptionRef<ClientEnd<P, U>> for ClientEnd<P, T>

where P: 'static, T: FromWireOptionRef<U>, U: Wire,

fn from_wire_option_ref(wire: &ClientEnd<P, U>) -> Option<ClientEnd<P, T>>

Converts the given wire reference to an option of this type.

impl<P, T, U> FromWireRef<ClientEnd<P, U>> for ClientEnd<P, T>

where T: FromWireRef<U>,

fn from_wire_ref(wire: &ClientEnd<P, U>) -> ClientEnd<P, T>

Converts the given wire reference to this type.

impl<P, T> Wire for ClientEnd<P, T>

where P: 'static, T: Wire,

type Decoded<'de> = ClientEnd<P, <T as Wire>::Decoded<'de>>

The decoded wire type, restricted to the 'de lifetime.

fn zero_padding(out: &mut MaybeUninit<ClientEnd<P, T>>)

Writes zeroes to the padding for this type, if any.

impl<P, T> Send for ClientEnd<P, T>

where T: Send,

impl<P, T> Sync for ClientEnd<P, T>

where T: Sync,