Struct lunatic::protocol::Protocol

pub struct Protocol<P: 'static, S = Bincode, Z: 'static = ()> { /* private fields */ }

A Protocol is a specific type of Process.

It uses session types to check during compile time that all messages exchanged between two processes are in the correct order and of the correct type.

Only Protocol<End> or Protocol<TaskEnd> can be dropped. All other protocols will panic if dropped without reaching Protocol<End> or `Protocol.

Implementations

impl<P, S, Z> Protocol<P, S, Z>

pub fn id(&self) -> u64

Returns the process ID for the local node.

pub fn node_id(&self) -> u64

Returns the node ID.

pub fn tag(&self) -> Tag

Returns the protocol tag.

pub fn from_process<M, S2>(process: Process<M, S2>) -> Self

Turn a process into a protocol.

This implicityly creates a new tag.

pub fn from_process_with_tag<M, S2>(process: Process<M, S2>, tag: Tag) -> Self

Turn a process into a protocol using a given Tag.

impl<P, A, S, Z> Protocol<Send<A, P>, S, Z>where S: CanSerialize<A>,

pub fn send(self, message: A) -> Protocol<P, S, Z>

Send a value of type A over the session. Returns a session with protocol P.

impl<P, A, S, Z> Protocol<Recv<A, P>, S, Z>where S: CanSerialize<A>,

pub fn receive(self) -> (Protocol<P, S, Z>, A)

Receives a value of type A from the session. Returns a tuple containing the resulting session and the received value.

impl<A, S, Z> Protocol<Recv<A, TaskEnd>, S, Z>where S: CanSerialize<A>,

pub fn result(self) -> A

A task is a special case of a protocol spawned with the spawn!(@task ...) macro. It only returns one value.

pub fn result_timeout(self, duration: Duration) -> Result<A, MailboxError>

A task is a special case of a protocol spawned with the spawn!(@task ...) macro. It only returns one value.

impl<P, Q, S, Z> Protocol<Choose<P, Q>, S, Z>where S: CanSerialize<bool>,

pub fn select_left(self) -> Protocol<P, S, Z>

Perform an active choice, selecting protocol P.

pub fn select_right(self) -> Protocol<Q, S, Z>

Perform an active choice, selecting protocol Q.

impl<P, Q, S, Z> Protocol<Offer<P, Q>, S, Z>where S: CanSerialize<bool>,

pub fn offer(self) -> Branch<Protocol<P, S, Z>, Protocol<Q, S, Z>>

Passive choice. This allows the other end of the session to select one of two options for continuing the protocol: either P or Q.

impl<P, S, Z> Protocol<Rec<P>, S, Z>

pub fn repeat(self) -> Protocol<P, S, Protocol<Rec<P>, S, Z>>

Repeat Protocol

impl<P2, S, Z> Protocol<Pop, S, Protocol<P2, S, Z>>

pub fn pop(self) -> Protocol<P2, S, Z>

Pop

Trait Implementations

impl<P, S, Z> Debug for Protocol<P, S, Z>

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

Formats the value using the given formatter.

impl<P: 'static, S, Z: 'static> Drop for Protocol<P, S, Z>

fn drop(&mut self)

Executes the destructor for this type.

impl<P, M, S, S2> From<Process<M, S>> for Protocol<P, S2>

fn from(process: Process<M, S>) -> Self

Converts to this type from the input type.

impl<P, S, Z> From<Protocol<Rec<P>, S, Z>> for Protocol<P, S, Z>

fn from(p: Protocol<Rec<P>, S, Z>) -> Self

Converts to this type from the input type.

impl<P: Hash + 'static, S: Hash, Z: Hash + 'static> Hash for Protocol<P, S, Z>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.