Struct ServerConnection 

pub struct ServerConnection<IO> { /* private fields */ }

Available on crate features icap and std only.

A sequential ICAP server over one established byte stream.

ServerConnection::accept returns a transaction which streams request body data and makes the Preview decision explicit. Dropping any transaction before its response completes poisons the connection.

Implementations

impl<IO> ServerConnection<IO>

where IO: Io + Unpin + ExtensionsRef,

pub fn new(io: IO) -> ServerConnection<IO>

Wrap an accepted stream with default connection options.

Bare streams can use rama_core::ServiceInput to supply the Rama connection extension store required by this protocol wrapper.

pub fn with_options(io: IO, options: ConnectionOptions) -> ServerConnection<IO>

Wrap an accepted stream with explicit bounds and parser policy.

The connection retains the extension store supplied by io.

pub const fn is_reusable(&self) -> bool

Return whether the next request can be read safely.

pub const fn is_closed(&self) -> bool

Return whether a completed transaction closed the connection.

pub const fn options(&self) -> &ConnectionOptions

Return the connection bounds and parser policy.

pub fn into_inner(self) -> IO

Recover the underlying stream.

Any bytes read ahead by the ICAP decoder are discarded. Use into_parts to retain them.

pub fn into_parts(self) -> (IO, Bytes)

Recover the underlying stream and bytes read ahead by the decoder.

impl<IO> ServerConnection<IO>

where IO: Io + Unpin,

pub async fn accept( &mut self, ) -> Result<Option<ServerTransaction<'_, IO>>, Error>

Read the next ICAP request head and encapsulated HTTP head sections.

Cancelling this future abandons the connection. This fail-closed rule prevents a partially consumed request head or HTTP prefix from being mistaken for the start of a later transaction.

Trait Implementations

impl<IO> ExtensionsRef for ServerConnection<IO>

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store