Struct ByteString 

pub struct ByteString { /* private fields */ }

Content of a byte string, CBOR major type 2.

A byte string is either definite, in which case it is encoded as a single run of bytes, or indefinite, in which case it is encoded as a sequence of definite chunks terminated by a break. The chunk boundaries are preserved so that a decoded item re-encodes to the exact same bytes, and they are reached through chunks and its mutable and owning counterparts.

Example

use cbor_next::ByteString;

let definite = ByteString::new([0x01, 0x02]);
assert!(!definite.is_indefinite());
assert_eq!(definite.to_bytes(), [0x01, 0x02]);

let indefinite = ByteString::from_chunks([vec![0x01], vec![0x02]]);
assert!(indefinite.is_indefinite());
assert_eq!(indefinite.chunks().len(), 2);
assert_eq!(indefinite.to_bytes(), [0x01, 0x02]);

Implementations

impl ByteString

pub fn new(bytes: impl Into<Vec<u8>>) -> Self

Create a definite length byte string from a single run of bytes.

pub fn from_chunks<I, B>(chunks: I) -> Self

where I: IntoIterator<Item = B>, B: Into<Vec<u8>>,

Create an indefinite length byte string from its chunks.

pub fn with_indefinite(self, indefinite: bool) -> Self

Return the same content with the definite or indefinite encoding selected.

Example

use cbor_next::ByteString;

let content = ByteString::new([0x01]).with_indefinite(true);
assert!(content.is_indefinite());

pub fn set_indefinite(&mut self, indefinite: bool)

Select the definite or indefinite encoding in place.

pub fn is_indefinite(&self) -> bool

Whether the byte string uses the indefinite length encoding.

pub fn chunks(&self) -> &[Vec<u8>]

The chunks the byte string is made of.

A definite length byte string is normally a single chunk.

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

The chunks the byte string is made of, mutably.

pub fn into_chunks(self) -> Vec<Vec<u8>>

Take ownership of the chunks the byte string is made of.

pub fn to_bytes(&self) -> Vec<u8>

All chunks concatenated into one buffer.

pub fn len(&self) -> usize

Total number of bytes across every chunk.

pub fn is_empty(&self) -> bool

Whether the byte string carries no bytes at all.

Trait Implementations

impl Clone for ByteString

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteString

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

Formats the value using the given formatter.

impl Default for ByteString

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ByteString

impl From<&[u8]> for ByteString

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

Converts to this type from the input type.

impl From<ByteString> for DataItem

fn from(value: ByteString) -> Self

Converts to this type from the input type.

impl From<TextString> for ByteString

fn from(value: TextString) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for ByteString

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for ByteString

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 Ord for ByteString

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ByteString

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ByteString

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for ByteString

impl TryFrom<ByteString> for TextString

type Error = FromUtf8Error

The type returned in the event of a conversion error.

fn try_from(value: ByteString) -> Result<Self, Self::Error>

Performs the conversion.