Struct PgsMemoryBuffer

pub struct PgsMemoryBuffer { /* private fields */ }

A memory buffer that supports reading and seeking operations.

Implementations

impl PgsMemoryBuffer

pub fn new() -> Self

Creates a new PgsMemoryBuffer instance.

Returns

Returns a new PgsMemoryBuffer with an empty buffer and position set to 0.

pub fn read_bytes<const N: usize>(&mut self) -> Result<[u8; N]>

Reads a fixed number of bytes into a fixed-size array.

Arguments

• N - The number of bytes to read, specified as a constant generic parameter.

Returns

Returns a Result containing an array of bytes on success, or an Error if the read operation fails.

pub fn read_into_vec(&mut self, length: u32) -> Result<Vec<u8>>

Reads a specified number of bytes into a Vec<u8>.

Arguments

• length - The number of bytes to read.

Returns

Returns a Result containing a vector of bytes on success, or an Error if the read operation fails.

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

Returns a slice of the remaining bytes in the buffer.

Returns

Returns a slice of the remaining bytes starting from the current position.

Trait Implementations

impl Default for PgsMemoryBuffer

fn default() -> PgsMemoryBuffer

Returns the “default value” for a type.

impl From<&[u8]> for PgsMemoryBuffer

fn from(buffer: &[u8]) -> Self

Creates a PgsMemoryBuffer from a byte slice.

Arguments

• buffer - A byte slice to initialize the PgsMemoryBuffer.

Returns

Returns a PgsMemoryBuffer containing the provided slice.

impl From<Vec<u8>> for PgsMemoryBuffer

fn from(buffer: Vec<u8>) -> Self

Creates a PgsMemoryBuffer from a Vec<u8>.

Arguments

• buffer - A Vec<u8> to initialize the PgsMemoryBuffer.

Returns

Returns a PgsMemoryBuffer containing the provided vector.

impl PgsSeek for PgsMemoryBuffer

fn seek(&mut self, to: usize) -> Result<usize>

Seeks to a specific position in the data.

fn pos(&mut self) -> Result<usize>

Gets the current position in the data.

fn len(&self) -> Result<usize>

Gets the total length of the data.

fn is_empty(&self) -> bool

Checks if the data is non-empty.

impl Read for PgsMemoryBuffer

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

Reads bytes from the buffer into the provided slice.

Arguments

• buffer - A mutable byte slice to read into.

Returns

Returns a Result containing the number of bytes read on success, or an Error if the read operation fails.

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

Reads bytes from the buffer into the provided slice, ensuring that the exact number of bytes is read.

Arguments

• buffer - A mutable byte slice to read into.

Returns

Returns a Result indicating success or failure of the read operation.

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_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.