Struct ntex_bytes::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_slice(&self) -> &[u8]

Get a reference to the underlying bytes.

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 fn slice(
    &self,
    range: impl RangeBounds<usize> + SliceIndex<str> + Clone
) -> ByteString

Returns a slice of self for the provided range.

This will increment the reference count for the underlying memory and return a new ByteString handle set to the slice.

This operation is O(1).

Examples

use ntex_bytes::ByteString;

let a = ByteString::from("hello world");
let b = a.slice(2..5);

assert_eq!(b, "llo");

Panics

Requires that begin <= end and end <= self.len(), otherwise slicing will panic.

pub fn split_off(&mut self, at: usize) -> ByteString

Splits the bytestring into two at the given index.

Afterwards self contains elements [0, at), and the returned ByteString contains elements [at, len).

This is an O(1) operation that just increases the reference count and sets a few indices.

Examples

use ntex_bytes::ByteString;

let mut a = ByteString::from("hello world");
let b = a.split_off(5);

assert_eq!(a, "hello");
assert_eq!(b, " world");

Panics

Panics if at > len.

pub fn split_to(&mut self, at: usize) -> ByteString

Splits the bytestring into two at the given index.

Afterwards self contains elements [at, len), and the returned Bytes contains elements [0, at).

This is an O(1) operation that just increases the reference count and sets a few indices.

Examples

use ntex_bytes::ByteString;

let mut a = ByteString::from("hello world");
let b = a.split_to(5);

assert_eq!(a, " world");
assert_eq!(b, "hello");

Panics

Panics if at > len.

pub fn trimdown(&mut self)

Shortens the buffer to len bytes and dropping the rest.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for ByteString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ByteString

fn clone(&self) -> ByteString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteString

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

Formats the value using the given formatter.

impl Default for ByteString

fn default() -> ByteString

Returns the “default value” for a type.

impl Deref for ByteString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'de> Deserialize<'de> for ByteString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ByteString

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

Formats the value using the given formatter.

impl From<&'_ str> for ByteString

fn from(value: &str) -> Self

Performs the conversion.

impl<'a> From<Cow<'a, str>> for ByteString

fn from(value: Cow<'a, str>) -> Self

Performs the conversion.

impl From<String> for ByteString

fn from(value: String) -> Self

Performs the conversion.

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for ByteString

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

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

impl PartialEq<str> for ByteString

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

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

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

This method tests for !=.

impl PartialOrd<ByteString> for ByteString

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

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

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

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

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

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

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

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

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

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

impl Serialize for ByteString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

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

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> 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.

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.

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.

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

Performs the conversion.

impl Eq for ByteString

impl StructuralEq for ByteString