Struct sodoken::BufRead

pub struct BufRead(pub Arc<dyn AsBufRead>);

A concrete read-only buffer type that may or may not be mem_locked.

Tuple Fields

0: Arc<dyn AsBufRead>

Implementations

impl BufRead

pub fn new_no_lock(content: &[u8]) -> Self

Construct a new BufRead that is NOT mem_locked.

pub fn len(&self) -> usize

The length of this buffer.

pub fn is_empty(&self) -> bool

Is this buffer empty?

pub fn read_lock(&self) -> ReadGuard<'_>

Obtain read access to the underlying buffer.

pub fn try_unwrap(self) -> Result<Box<[u8]>, BufRead>

Attempt to extract the inner contents of this buf without cloning. If this memory is locked or there are clones of this reference, the unwrap will fail, returning a BufRead instance.

Trait Implementations

impl Clone for BufRead

fn clone(&self) -> BufRead

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BufRead

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for BufRead

fn from(b: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<Arc<[u8]>> for BufRead

fn from(b: Arc<[u8]>) -> Self

Converts to this type from the input type.

impl From<Box<[u8], Global>> for BufRead

fn from(b: Box<[u8]>) -> Self

Converts to this type from the input type.

impl<const S: usize> From<BufReadSized<S>> for BufRead

fn from(b: BufReadSized<S>) -> Self

Converts to this type from the input type.

impl From<BufWrite> for BufRead

fn from(b: BufWrite) -> Self

Converts to this type from the input type.

impl<const S: usize> From<BufWriteSized<S>> for BufRead

fn from(b: BufWriteSized<S>) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for BufRead

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

Converts to this type from the input type.