Struct puffin::agent::Agent

pub struct Agent<PB: ProtocolBehavior> {
    descriptor: AgentDescriptor,
    put: Box<dyn Put<PB>>,
}

An Agent holds a non-cloneable reference to a Stream.

Fields

descriptor: AgentDescriptor

put: Box<dyn Put<PB>>

Implementations

impl<PB: ProtocolBehavior> Agent<PB>

pub fn new(descriptor: AgentDescriptor, put: Box<dyn Put<PB>>) -> Self

pub fn progress(&mut self) -> Result<(), Error>

pub fn reset(&mut self, new_name: AgentName) -> Result<(), Error>

pub fn shutdown(&mut self) -> String

Shut down the agent by consuming it and returning a string that summarizes the execution.

pub fn is_state_successful(&self) -> bool

Checks whether the agent is in a good state.

pub fn is_reusable_with(&self, other: &AgentDescriptor) -> bool

Checks whether the agent is reusable with the descriptor.

pub fn name(&self) -> AgentName

pub fn put(&self) -> &dyn Put<PB>

pub fn put_mut(&mut self) -> &mut dyn Put<PB>

Trait Implementations

impl<PB: ProtocolBehavior> Debug for Agent<PB>

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

Formats the value using the given formatter.

impl<PB: ProtocolBehavior> PartialEq for Agent<PB>

fn eq(&self, other: &Self) -> 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<PB: ProtocolBehavior> Stream<PB> for Agent<PB>

fn add_to_inbound(&mut self, message_flight: &PB::OpaqueProtocolMessageFlight)

fn take_message_from_outbound( &mut self, ) -> Result<Option<PB::OpaqueProtocolMessageFlight>, Error>

Takes a single TLS message from the outbound channel