Struct Buffer

pub struct Buffer<K: AllocKind> { /* private fields */ }

The buffer that can be used by the Session.

All Buffers implement std::io::Read and Buffer<Tx>s implement std::io::Write.

Implementations

impl<K: AllocKind> Buffer<K>

pub fn cap(&self) -> usize

Gets the capacity of the buffer in bytes as requested for allocation.

pub fn len(&self) -> usize

Gets the length of the buffer which is actually used.

pub fn write_at(&mut self, offset: usize, src: &[u8]) -> Result<()>

Writes bytes to the buffer.

Writes up to src.len() bytes into the buffer beginning at offset, returning how many bytes were written successfully. Partial write is not considered as an error.

pub fn read_at(&self, offset: usize, dst: &mut [u8]) -> Result<()>

Reads bytes from the buffer.

Reads up to dst.len() bytes from the buffer beginning at offset, returning how many bytes were read successfully. Partial read is considered as an error.

pub fn frame_type(&self) -> Result<FrameType>

Retrieves the frame type of the buffer.

pub fn port(&self) -> Port

Retrieves the buffer’s source port.

impl Buffer<Tx>

pub fn set_port(&mut self, port: Port)

Sets the buffer’s destination port.

pub fn set_frame_type(&mut self, frame_type: FrameType)

Sets the frame type of the buffer.

pub fn set_tx_flags(&mut self, flags: TxFlags)

Sets TxFlags of a Tx buffer.

impl Buffer<Rx>

pub async fn into_tx(self) -> Buffer<Tx>

Turns an rx buffer into a tx one.

pub fn rx_flags(&self) -> Result<RxFlags>

Retrieves RxFlags of an Rx Buffer.

Trait Implementations

impl<K: AllocKind> Debug for Buffer<K>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K: AllocKind> Read for Buffer<K>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<K: AllocKind> Seek for Buffer<K>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

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

Rewind to the beginning of a stream.

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

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

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

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl Write for Buffer<Tx>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.