Trait puffin::put::Put

pub trait Put<PB: ProtocolBehavior>: Stream<PB> + 'static {
    // Required methods
    fn progress(&mut self) -> Result<(), Error>;
    fn reset(&mut self, new_name: AgentName) -> Result<(), Error>;
    fn descriptor(
        &self,
    ) -> &AgentDescriptor<<<PB as ProtocolBehavior>::ProtocolTypes as ProtocolTypes>::PUTConfig>;
    fn describe_state(&self) -> String;
    fn is_state_successful(&self) -> bool;
    fn shutdown(&mut self) -> String;
    fn version() -> String
       where Self: Sized;
}

Generic trait used to define the interface with a concrete library implementing the protocol.

Required Methods

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

Process incoming buffer, internal progress, can fill in the output buffer

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

In-place reset of the state

fn descriptor( &self, ) -> &AgentDescriptor<<<PB as ProtocolBehavior>::ProtocolTypes as ProtocolTypes>::PUTConfig>

fn describe_state(&self) -> String

Returns a textual representation of the state in which self is

fn is_state_successful(&self) -> bool

Checks whether the Put is in a good state

fn shutdown(&mut self) -> String

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

fn version() -> String

where Self: Sized,

Returns a textual representation of the version of the PUT used by self

Implementors