Struct dialectic::Available

pub struct Available<C>(_);

An available Transmit or Receive end of a connection.

When using split, the resultant two channels can only send or only receive, respectively. This is reflected at the type level by the presence of Available on the type of the connection which is present for each part of the split, and Unavailable on the type of the connection which is not.

Whenever C implements Transmit or Receive, so does Available<C>.

Implementations

impl<C> Available<C>

pub fn into_inner(self) -> C

Retrieve the inner C connection.

Trait Implementations

impl<C> AsMut<C> for Available<C>

pub fn as_mut(&mut self) -> &mut C

Performs the conversion.

impl<C> AsRef<C> for Available<C>

pub fn as_ref(&self) -> &C

Performs the conversion.

impl<C: Clone> Clone for Available<C>

pub fn clone(&self) -> Available<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Copy> Copy for Available<C>

impl<C: Debug> Debug for Available<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for Available<C>

pub fn default() -> Available<C>

Returns the "default value" for a type.

impl<C: Eq> Eq for Available<C>

impl<C: Hash> Hash for Available<C>

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<C: PartialEq> PartialEq<Available<C>> for Available<C>

pub fn eq(&self, other: &Available<C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Available<C>) -> bool

This method tests for !=.

impl<C: PartialOrd> PartialOrd<Available<C>> for Available<C>

pub fn partial_cmp(&self, other: &Available<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Available<C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Available<C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Available<C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Available<C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, C> Receive<T> for Available<C> where
    C: Receive<T>, 

type Error = C::Error

The type of possible errors when receiving.

pub fn recv<'async_lifetime>(
    &'async_lifetime mut self
) -> Pin<Box<dyn Future<Output = Result<T, Self::Error>> + Send + 'async_lifetime>>

Receive a message. This may require type annotations for disambiguation.

impl<C> StructuralEq for Available<C>

impl<C> StructuralPartialEq for Available<C>

impl<T, Convention: CallingConvention, C> Transmit<T, Convention> for Available<C> where
    C: Transmit<T, Convention>, 

type Error = C::Error

The type of possible errors when sending.

pub fn send<'a, 'async_lifetime>(
    &'async_lifetime mut self,
    message: <T as CallBy<'a, Convention>>::Type
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_lifetime>> where
    T: CallBy<'a, Convention>,
    <T as CallBy<'a, Convention>>::Type: Send,
    'a: 'async_lifetime, 

Send a message using the CallingConvention specified by the trait implementation.