Struct FramedConn

pub struct FramedConn<A> {
    inner: Buffer<Framed<Conn<A>, Codec>, BackendMessage>,
}

A connection that manages the encoding and decoding of pgwire frames.

Fields

inner: Buffer<Framed<Conn<A>, Codec>, BackendMessage>

Implementations

impl<A> FramedConn<A>

where A: AsyncRead + AsyncWrite + Unpin,

pub fn new(inner: Conn<A>) -> FramedConn<A>

Constructs a new framed connection.

The underlying connection, inner, is expected to be something like a TCP stream. Anything that implements AsyncRead and AsyncWrite will do.

pub async fn recv(&mut self) -> Result<Option<FrontendMessage>, Error>

Reads and decodes one frontend message from the client.

Blocks until the client sends a complete message. If the client terminates the stream, returns None. Returns an error if the client sends a malformed message or if the connection underlying is broken.

Cancel safety

This method is cancel safe. The returned future only holds onto a reference to thea underlying stream, so dropping it will never lose a value.

https://docs.rs/tokio-stream/latest/tokio_stream/trait.StreamExt.html#cancel-safety-1

pub async fn send<M>(&mut self, message: M) -> Result<(), Error>

where M: Into<BackendMessage>,

Encodes and sends one backend message to the client.

Note that the connection is not flushed after calling this method. You must call FramedConn::flush explicitly. Returns an error if the underlying connection is broken.

Please use StateMachine::send instead if calling from StateMachine, as it applies session-based filters before calling this method.

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

Flushes all outstanding messages.

impl<A> FramedConn<A>

where A: AsyncRead + AsyncWrite + Unpin,

pub fn inner(&self) -> &Conn<A>

pub fn inner_mut(&mut self) -> &mut Conn<A>

Trait Implementations

impl<A> AsyncReady for FramedConn<A>

where A: AsyncRead + AsyncWrite + AsyncReady + Send + Sync + Unpin,

fn ready<'life0, 'async_trait>( &'life0 self, interest: Interest, ) -> Pin<Box<dyn Future<Output = Result<Ready>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks for IO readiness.