Struct SendFlushOnDrop

pub struct SendFlushOnDrop<T>
where
    T: Transport,
{
    pub inner: T,
    /* private fields */
}

Available on crate features blocking-client or async-client only.

A utility to automatically send a flush packet when the instance is dropped, assuring a graceful termination of any interaction with the server.

Fields

inner: T

The actual transport instance.

Implementations

impl<T> SendFlushOnDrop<T>

where T: Transport,

pub fn new(transport: T, trace_packetlines: bool) -> Self

Create a new instance with transport, while optionally tracing packetlines with trace_packetlines.

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

Useful to explicitly invalidate the connection by sending a flush-packet. This will happen exactly once, and it is not considered an error to call it multiple times.

For convenience, this is not consuming, but could be to assure the underlying transport isn’t used anymore.

Trait Implementations

impl<T> Drop for SendFlushOnDrop<T>

where T: Transport,

fn drop(&mut self)

Executes the destructor for this type.