Struct kserd::Barr

pub struct Barr<'a> {
    pub inner: Cow<'a, [u8]>,
}

An owned or borrowed byte array.

Barr provides a thin wrapper around Cow<u8>. The smart pointer allows the byte array to be borrowed up until the point of mutation, at which point a clone is made.

Fields

inner: Cow<'a, [u8]>

Inner access to the underlying clone-on-write smart pointer.

Methods

impl<'a> Barr<'a>

pub const fn brwed(bytes: &'a [u8]) -> Self

A new borrowed byte array. Barr has the same lifetime as the borrowed data.

pub const fn owned(bytes: Vec<u8>) -> Barr<'static>

A new owned byte array. Takes ownership of the vector of bytes and has a 'static lifetime.

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

Represent the byte array as a slice.

Example

let barr = Barr::owned(vec![0,1,2]);
assert_eq!(barr.as_bytes(), &[0,1,2]);

pub fn to_mut(&mut self) -> &mut Vec<u8>

Acquires a mutable reference to the owned vector of bytes.

Allocates a new vector and clones the data if not already owned.

Example

let mut barr = Barr::brwed([0,1,2,3].as_ref());
barr.to_mut().push(4);
assert_eq!(barr, Barr::brwed([0,1,2,3,4].as_ref()));

pub fn into_owned(self) -> Barr<'static>

Makes the underlying byte array owned.

Allocates a new vector and clones the data if it is not already owned. This upgrades the lifetime to 'static.

Example

let mut barr = Barr::brwed([0,1,2,3].as_ref());    
assert_eq!(barr.to_owned(), Barr::owned(vec![0,1,2,3]));

Trait Implementations

impl<'a> AsRef<[u8]> for Barr<'a>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'a> Clone for Barr<'a>

fn clone(&self) -> Barr<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Barr<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Barr<'a>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl<'a> Eq for Barr<'a>

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

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

Performs the conversion.

impl From<Vec<u8>> for Barr<'static>

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

Performs the conversion.

impl<'a> Hash for Barr<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Ord for Barr<'a>

fn cmp(&self, other: &Barr<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'a> PartialEq<[u8]> for Barr<'a>

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, '_> PartialEq<[u8]> for &'_ Barr<'a>

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Barr<'a>> for Barr<'a>

fn eq(&self, other: &Barr<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Barr<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Barr<'a>> for Barr<'a>

fn partial_cmp(&self, other: &Barr<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Barr<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Barr<'a>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Barr<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Barr<'a>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralEq for Barr<'a>

impl<'a> StructuralPartialEq for Barr<'a>