Struct ClientEnd 

pub struct ClientEnd<P, T = <P as HasTransport>::Transport> { /* 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) -> Self

Returns a new endpoint over the given transport.

pub fn into_untyped(self) -> T

Returns the underlying transport.

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

where T: HasExecutor,

Returns the executor for the underlying transport.

impl<P, T: Transport> ClientEnd<P, T>

pub fn spawn_handler_full_on_with<H, E>( self, create_handler: impl FnOnce(Client<P, T>) -> H, executor: &E, ) -> (Client<P, T>, HandlerTask<T, H, E>)

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

Spawns a dispatcher for the given client end with a handler computed from a closure on an executor.

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

pub fn spawn_handler_full_on<H, E>( self, handler: H, executor: &E, ) -> (Client<P, T>, HandlerTask<T, H, E>)

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

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

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

pub fn spawn_handler_on_with<H, E>( self, create_handler: impl FnOnce(Client<P, T>) -> H, executor: &E, ) -> Client<P, T>

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

Spawns a dispatcher for the given client end with a handler computed from a closure on an executor.

Returns the client.

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

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

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

Returns the client.

pub fn spawn_handler_full_with<H>( self, create_handler: impl FnOnce(Client<P, T>) -> H, ) -> (Client<P, T>, HandlerTask<T, H>)

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

Spawns a dispatcher for the given client end with a handler computed from a closure on the default executor for the transport.

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

pub fn spawn_handler_full<H>( self, handler: H, ) -> (Client<P, T>, HandlerTask<T, H>)

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

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

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

pub fn spawn_handler_with<H>( self, create_handler: impl FnOnce(Client<P, T>) -> H, ) -> Client<P, T>

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

Spawns a dispatcher for the given client end with a handler computed from a closure on the default executor for the transport.

Returns the client.

pub fn spawn_handler<H>(self, handler: H) -> Client<P, T>

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

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

Returns the client.

pub fn spawn_full_on<E>( self, executor: &E, ) -> (Client<P, T>, HandlerTask<T, (), E>)

where P: DispatchClientMessage<IgnoreEvents, T>, T: 'static, E: Executor,

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

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

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

where P: DispatchClientMessage<IgnoreEvents, T>, T: 'static, E: Executor,

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

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

pub fn spawn_full(self) -> (Client<P, T>, HandlerTask<T, ()>)

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

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

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

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

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

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

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

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>) -> Self

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>) -> Self

Converts value into a value of this type.

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

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

Formats the value using the given formatter.

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

where D: ?Sized, P: 'static, T: Decode<D> + Constrained<Constraint = ()>,

fn decode( slot: Slot<'_, Self>, decoder: &mut D, constraint: <Self as Constrained>::Constraint, ) -> Result<(), DecodeError>

Decodes a value into a slot using a decoder.

impl<'a, W, E, P, T> Encode<ClientEnd<P, W>, E> for &'a ClientEnd<P, T>

where E: ?Sized, P: 'static, &'a T: Encode<W, E>, W: Constrained<Constraint = ()> + Wire,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<ClientEnd<P, W>>, constraint: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

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

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

where E: ?Sized, P: 'static, T: Encode<W, E>, W: Constrained<Constraint = ()> + Wire,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<ClientEnd<P, W>>, constraint: (), ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

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

impl<'a, W, E, P, T> EncodeOption<ClientEnd<P, W>, E> for &'a ClientEnd<P, T>

where E: ?Sized, P: 'static, &'a T: EncodeOption<W, E>, W: Constrained<Constraint = ()>,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<ClientEnd<P, W>>, constraint: (), ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

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

where E: ?Sized, P: 'static, T: EncodeOption<W, E>, W: Constrained<Constraint = ()>,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<ClientEnd<P, W>>, constraint: (), ) -> Result<(), EncodeError>

Encodes this optional value 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>) -> Self

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<Self>

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<Self>

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>) -> Self

Converts the given wire reference to this type.

impl<P, T: IntoNatural> IntoNatural for ClientEnd<P, T>

type Natural = ClientEnd<P, <T as IntoNatural>::Natural>

A good default type for this wire type to convert into.

fn into_natural(self) -> Self::Natural

Converts this type into its natural equivalent.

impl<P: PartialEq, T: PartialEq> PartialEq for ClientEnd<P, T>

fn eq(&self, other: &ClientEnd<P, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: 'static, T: Wire> Wire for ClientEnd<P, T>

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

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

fn zero_padding(out: &mut MaybeUninit<Self>)

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

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

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

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

impl<P, T: Constrained<Constraint = ()>> Unconstrained for ClientEnd<P, T>