Struct bytestring::ByteString

pub struct ByteString(_);

An immutable UTF-8 encoded string with Bytes as a storage.

Implementations

impl ByteString

pub const fn new() -> Self

Creates a new empty ByteString.

pub fn as_bytes(&self) -> &Bytes

Get a reference to the underlying Bytes object.

pub fn into_bytes(self) -> Bytes

Unwraps this ByteString into the underlying Bytes object.

pub const fn from_static(src: &'static str) -> ByteString

Creates a new ByteString from a &'static str.

pub const unsafe fn from_bytes_unchecked(src: Bytes) -> ByteString

Creates a new ByteString from a Bytes.

Safety

This function is unsafe because it does not check the bytes passed to it are valid UTF-8. If this constraint is violated, it may cause memory unsafety issues with future users of the ByteString, as we assume that ByteStrings are valid UTF-8. However, the most likely issue is that the data gets corrupted.

Trait Implementations

impl AsRef<[u8]> for ByteString

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

Performs the conversion.

impl AsRef<str> for ByteString

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for ByteString

pub fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ByteString

pub fn clone(&self) -> ByteString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteString

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

Formats the value using the given formatter.

impl Default for ByteString

pub fn default() -> ByteString

Returns the "default value" for a type.

impl Deref for ByteString

type Target = str

The resulting type after dereferencing.

pub fn deref(&self) -> &str

Dereferences the value.

impl Display for ByteString

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

Formats the value using the given formatter.

impl Eq for ByteString

impl From<&'_ str> for ByteString

pub fn from(value: &str) -> Self

Performs the conversion.

impl From<String> for ByteString

pub fn from(value: String) -> Self

Performs the conversion.

impl Hash for ByteString

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ByteString

pub fn cmp(&self, other: &ByteString) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: AsRef<str>> PartialEq<T> for ByteString

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

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

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

This method tests for !=.

impl PartialEq<str> for ByteString

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

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

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

This method tests for !=.

impl PartialOrd<ByteString> for ByteString

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ByteString

impl TryFrom<&'_ [u8; 0]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 0]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 1]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 1]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 10]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 10]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 11]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 11]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 12]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 12]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 13]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 13]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 14]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 14]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 15]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 15]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 16]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 16]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 17]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 17]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 18]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 18]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 19]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 19]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 2]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 20]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 20]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 21]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 21]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 22]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 22]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 23]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 23]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 24]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 24]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 25]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 25]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 26]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 26]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 27]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 27]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 28]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 28]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 29]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 29]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 3]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 30]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 30]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 31]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 31]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 32]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 32]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 4]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 5]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 5]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 6]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 6]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 7]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 7]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 8]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8; 9]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8; 9]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ [u8]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 0]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 0]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 1]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 1]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 10]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 10]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 11]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 11]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 12]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 12]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 13]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 13]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 14]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 14]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 15]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 15]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 16]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 16]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 17]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 17]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 18]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 18]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 19]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 19]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 2]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 20]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 20]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 21]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 21]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 22]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 22]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 23]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 23]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 24]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 24]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 25]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 25]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 26]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 26]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 27]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 27]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 28]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 28]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 29]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 29]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 3]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 30]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 30]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 31]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 31]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 32]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 32]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 4]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 5]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 5]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 6]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 6]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 7]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 7]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 8]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 9]> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: [u8; 9]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<BytesMut> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for ByteString

type Error = Utf8Error

The type returned in the event of a conversion error.

pub fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.