Struct dialectic::Branches

#[must_use]pub struct Branches<Tx, Rx, Choices, E = ()> where
    Choices: Tuple,
    Choices::AsList: EachActionable<E>,
    E: Environment,
    E::Dual: Environment,  { /* fields omitted */ }

The result of offer, Branches<Tx, Rx, Ps> represents an enumeration of the possible new channel states that could result from the offering of the type-level list of protocols Ps.

To find out which protocol was selected by the other party, use Branches::case, or better yet, use the offer! macro to ensure you don't miss any cases.

Implementations

impl<'a, Tx, Rx, Choices, P, Ps, E> Branches<Tx, Rx, Choices, E> where
    Choices: Tuple<AsList = (P, Ps)>,
    (P, Ps): List<AsTuple = Choices>,
    P: Actionable<E>,
    Ps: EachActionable<E> + List,
    E: Environment,
    E::Dual: Environment,
    P::Dual: Actionable<E::Dual>,
    <P::Env as EachSession>::Dual: Environment,
    <<P::Action as Actionable<P::Env>>::Env as EachSession>::Dual: Environment,
    <<P::Dual as Actionable<E::Dual>>::Env as EachSession>::Dual: Environment, 

#[must_use = "all possible choices must be handled (add cases to match the type of this `Offer<...>`)"]pub fn case(
    self
) -> Result<Chan<Tx, Rx, <P as Actionable<E>>::Action, <P as Actionable<E>>::Env>, Branches<Tx, Rx, Ps::AsTuple, E>>

Check if the selected protocol in this Branches was P. If so, return the corresponding channel; otherwise, return all the other possibilities.

impl<'a, Tx, Rx, E: Environment> Branches<Tx, Rx, (), E> where
    E::Dual: Environment, 

pub fn empty_case<T>(self) -> Result<T, OutOfRangeChoice>

Attempt to eliminate an empty Branches, returning an error if the originating discriminant for this set of protocol choices was out of range.

This function is only callable on empty Branches, which under ordinary circumstances means it proves the unreachability of its calling location. However, if the other end of the channel breaks protocol, an empty Branches can in fact be constructed, and this function will then signal an error.

Trait Implementations

impl<Tx: Debug, Rx: Debug, Choices: Debug, E: Debug> Debug for Branches<Tx, Rx, Choices, E> where
    Choices: Tuple,
    Choices::AsList: EachActionable<E>,
    E: Environment,
    E::Dual: Environment, 

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

Formats the value using the given formatter.