Struct ByteString 

pub struct ByteString<'a>(/* private fields */);

Conversion helper for Value::byte_string.

Wraps a Cow<'a, [u8]> so that Value::byte_string can accept owned and borrowed byte inputs through a single impl Into<ByteString> bound. This mirrors how Array and Map abstract their input shapes.

Supported source types:

• &'a [u8] (and any &'a T with T: AsRef<[u8]>) borrows zero-copy.
• Owned Vec<u8> is moved without copying.
• Fixed-size [u8; N] (by value) is copied into a Vec<u8>.
• Cow<'a, [u8]> is preserved as-is.

// Borrows from the slice:
let buf: Vec<u8> = vec![1, 2, 3];
let v = Value::byte_string(buf.as_slice());
assert_eq!(v.as_bytes().unwrap(), &[1, 2, 3]);

// Owns its storage:
let v = Value::byte_string(vec![1u8, 2, 3]);
assert_eq!(v.as_bytes().unwrap(), &[1, 2, 3]);

Implementations

impl<'a> ByteString<'a>

pub const fn new() -> Self

Create an empty byte string.

The result is Cow::Borrowed(&[]) and lives for any lifetime.

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

Borrow the contents as a &[u8].

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

Borrow the contents as a mutable Vec<u8>, cloning if the inner Cow is currently borrowed.

pub fn into_owned<'b>(self) -> ByteString<'b>

Detach from any borrow, returning a ByteString with an independent lifetime.

A borrowed ByteString<'a> is copied into an owned Vec<u8>; an already-owned one is returned unchanged. The result can be assigned to any lifetime, in particular ByteString<'static>.

Trait Implementations

impl<'a> Clone for ByteString<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ByteString<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ByteString<'a>

fn default() -> ByteString<'a>

Returns the “default value” for a type.

impl<'a, T> From<&'a T> for ByteString<'a>

where T: AsRef<[u8]> + ?Sized,

fn from(value: &'a T) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<[u8; N]> for ByteString<'a>

fn from(value: [u8; N]) -> Self

Converts to this type from the input type.

impl<'a> From<ByteString<'a>> for Value<'a>

fn from(value: ByteString<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, [u8]>> for ByteString<'a>

fn from(value: Cow<'a, [u8]>) -> Self

Converts to this type from the input type.

impl<'a> From<Vec<u8>> for ByteString<'a>

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

Converts to this type from the input type.

impl<'a> Hash for ByteString<'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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ByteString<'a>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for ByteString<'a>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for ByteString<'a>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<'a> Eq for ByteString<'a>

impl<'a> StructuralPartialEq for ByteString<'a>