Struct nix_compat::wire::ser::NixWriter

pub struct NixWriter<W> {
    inner: W,
    buf: BytesMut,
    reserved_buf_size: usize,
    max_buf_size: usize,
    version: ProtocolVersion,
}

Fields

inner: W

buf: BytesMut

reserved_buf_size: usize

max_buf_size: usize

version: ProtocolVersion

Implementations

impl NixWriter<Cursor<Vec<u8>>>

pub fn builder() -> NixWriterBuilder

impl<W> NixWriter<W>

where W: AsyncWriteExt,

pub fn new(writer: W) -> NixWriter<W>

pub fn buffer(&self) -> &[u8]

pub fn set_version(&mut self, version: ProtocolVersion)

pub fn remaining_mut(&self) -> usize

Remaining capacity in internal buffer

fn poll_flush_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

impl<W> NixWriter<W>

where W: AsyncWriteExt + Unpin,

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

Trait Implementations

impl<W> AsyncWrite for NixWriter<W>

where W: AsyncWrite,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W> NixWrite for NixWriter<W>

where W: AsyncWrite + Send + Unpin,

type Error = Error

fn version(&self) -> ProtocolVersion

Some types are serialized differently depending on the version of the protocol and so this can be used for implementing that.

async fn write_number(&mut self, value: u64) -> Result<(), Self::Error>

Write a single u64 to the protocol.

async fn write_slice(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write a slice of bytes to the protocol.

async fn write_display<D>(&mut self, msg: D) -> Result<(), Self::Error>

where D: Display + Send, Self: Sized,

Write a value that implements std::fmt::Display to the protocol. The protocol uses many small string formats and instead of allocating a String each time we want to write one an implementation of NixWrite can instead use Display to dump these formats to a reusable buffer.

fn write_value<V>( &mut self, value: &V, ) -> impl Future<Output = Result<(), Self::Error>> + Send

where V: NixSerialize + Send + ?Sized, Self: Sized,

Write a value to the protocol. Uses NixSerialize::serialize to write the value.

impl<'__pin, W> Unpin for NixWriter<W>

where __Origin<'__pin, W>: Unpin,