Struct strchunk::StrChunkMut

pub struct StrChunkMut { /* fields omitted */ }

A unique reference to a contiguous UTF-8 slice in memory.

StrChunkMut builds on the memory slice view semantics of BytesMut from the bytes crate, with the added guarantee that the content is a valid UTF-8 string.

Implementations

impl StrChunkMut

pub fn new() -> Self

Creates a new StrChunkMut with default capacity.

The returned buffer has initialized length 0 and unspecified capacity.

pub fn with_capacity(capacity: usize) -> Self

Creates a new StrChunkMut with the specified capacity.

The returned buffer will be able to hold strings with lengths of at least capacity without reallocating. The initialized length is 0.

pub fn len(&self) -> usize

Returns the length of the initialized string content in this StrChunkMut.

pub fn is_empty(&self) -> bool

Returns true if the initialized string content in StrChunkMut has a length of 0.

pub fn capacity(&self) -> usize

Returns the maximum length of a string this StrChunkMut can hold without reallocating.

pub fn remaining_mut(&self) -> usize

Returns the maximum length of string content that can be appended past the current length without reallocating.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more bytes of string content to be inserted into this StrChunkMut.

pub fn freeze(self) -> StrChunk

Converts self into an immutable StrChunk.

The conversion is zero cost and is used to indicate that the slice referenced by the handle will no longer be mutated. Once the conversion is done, the handle can be cloned and shared across threads.

pub fn as_str(&self) -> &str

Represents the StrChunkMut contents as a string slice.

pub fn as_mut_str(&mut self) -> &mut str

Represents the StrChunkMut contents as a mutable string slice.

pub fn put_char(&mut self, c: char)

Appends a Unicode character, encoded into UTF-8, to the initialized string contents of the StrChunkMut.

Panics

Panics if the remaining capacity is not sufficient to encode the character. Four bytes are enough to encode any char.

pub fn put_str<S: AsRef<str>>(&mut self, string: S)

Appends a string slice to the initialized string contents of the StrChunkMut.

Panics

Panics if the remaining capacity is not sufficient.

Trait Implementations

impl AsMut<str> for StrChunkMut

fn as_mut(&mut self) -> &mut str

Performs the conversion.

impl AsRef<[u8]> for StrChunkMut

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

Performs the conversion.

impl AsRef<str> for StrChunkMut

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for StrChunkMut

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl BorrowMut<str> for StrChunkMut

fn borrow_mut(&mut self) -> &mut str

Mutably borrows from an owned value.

impl Clone for StrChunkMut

fn clone(&self) -> StrChunkMut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrChunkMut

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

Formats the value using the given formatter.

impl Default for StrChunkMut

fn default() -> StrChunkMut

Returns the "default value" for a type.

impl Deref for StrChunkMut

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl DerefMut for StrChunkMut

fn deref_mut(&mut self) -> &mut str

Mutably dereferences the value.

impl Display for StrChunkMut

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

Formats the value using the given formatter.

impl Eq for StrChunkMut

impl<'a> Extend<&'a str> for StrChunkMut

fn extend<T>(&mut self, iterable: T) where
    T: IntoIterator<Item = &'a str>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<char> for StrChunkMut

fn extend<T>(&mut self, iterable: T) where
    T: IntoIterator<Item = char>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<&'a str> for StrChunkMut

fn from(src: &'a str) -> StrChunkMut

Performs the conversion.

impl From<StrChunkMut> for StrChunk

fn from(src: StrChunkMut) -> StrChunk

Performs the conversion.

impl From<StrChunkMut> for Bytes

fn from(src: StrChunkMut) -> Bytes

Performs the conversion.

impl From<StrChunkMut> for BytesMut

fn from(src: StrChunkMut) -> BytesMut

Performs the conversion.

impl<'a> FromIterator<&'a str> for StrChunkMut

fn from_iter<T>(iterable: T) -> Self where
    T: IntoIterator<Item = &'a str>, 

Creates a value from an iterator.

impl FromIterator<char> for StrChunkMut

fn from_iter<T>(iterable: T) -> Self where
    T: IntoIterator<Item = char>, 

Creates a value from an iterator.

impl Hash for StrChunkMut

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 StrChunkMut

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]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<&'a str> for StrChunkMut

fn eq(&self, other: &&'a str) -> 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<Cow<'a, str>> for StrChunkMut

fn eq(&self, other: &Cow<'a, str>) -> 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 PartialEq<StrChunk> for StrChunkMut

fn eq(&self, other: &StrChunk) -> 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 PartialEq<StrChunkMut> for StrChunk

fn eq(&self, other: &StrChunkMut) -> 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 PartialEq<StrChunkMut> for StrChunkMut

fn eq(&self, other: &StrChunkMut) -> 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 PartialEq<StrChunkMut> for str

fn eq(&self, other: &StrChunkMut) -> 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<StrChunkMut> for &'a str

fn eq(&self, other: &StrChunkMut) -> 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 PartialEq<StrChunkMut> for String

fn eq(&self, other: &StrChunkMut) -> 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<StrChunkMut> for Cow<'a, str>

fn eq(&self, other: &StrChunkMut) -> 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 PartialEq<String> for StrChunkMut

fn eq(&self, other: &String) -> 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 PartialEq<str> for StrChunkMut

fn eq(&self, other: &str) -> 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> PartialOrd<&'a str> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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<'a> PartialOrd<Cow<'a, str>> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<StrChunk> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<StrChunkMut> for StrChunk

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<StrChunkMut> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<StrChunkMut> for str

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

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

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

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

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

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

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

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

#[must_use]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<'a> PartialOrd<StrChunkMut> for &'a str

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<StrChunkMut> for String

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

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

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

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

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

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

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

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

#[must_use]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<'a> PartialOrd<StrChunkMut> for Cow<'a, str>

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<String> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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 PartialOrd<str> for StrChunkMut

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

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

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

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

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

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

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

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

#[must_use]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 StructuralEq for StrChunkMut

impl TakeRange<RangeFrom<usize>> for StrChunkMut

type Output = StrChunkMut

The value returned by the take_range method, representing the extracted part of the collection.

fn take_range(&mut self, range: RangeFrom<usize>) -> Self::Output

Splits off and returns part of the collection designated by the given range. The remaining part is left in self with indices adjusted after the removal.

fn remove_range(&mut self, range: RangeFrom<usize>)

Removes items from the the collection as designated by the given range. The remaining part is left in self with indices adjusted after the removal.

impl TakeRange<RangeFull> for StrChunkMut

type Output = StrChunkMut

The value returned by the take_range method, representing the extracted part of the collection.

fn take_range(&mut self, range: RangeFull) -> Self::Output

Splits off and returns part of the collection designated by the given range. The remaining part is left in self with indices adjusted after the removal.

fn remove_range(&mut self, range: RangeFull)

Removes items from the the collection as designated by the given range. The remaining part is left in self with indices adjusted after the removal.

impl TakeRange<RangeTo<usize>> for StrChunkMut

type Output = StrChunkMut

The value returned by the take_range method, representing the extracted part of the collection.

fn take_range(&mut self, range: RangeTo<usize>) -> Self::Output

Splits off and returns part of the collection designated by the given range. The remaining part is left in self with indices adjusted after the removal.

fn remove_range(&mut self, range: RangeTo<usize>)

Removes items from the the collection as designated by the given range. The remaining part is left in self with indices adjusted after the removal.

impl TakeRange<RangeToInclusive<usize>> for StrChunkMut

type Output = StrChunkMut

The value returned by the take_range method, representing the extracted part of the collection.

fn take_range(&mut self, range: RangeToInclusive<usize>) -> Self::Output

Splits off and returns part of the collection designated by the given range. The remaining part is left in self with indices adjusted after the removal.

fn remove_range(&mut self, range: RangeToInclusive<usize>)

Removes items from the the collection as designated by the given range. The remaining part is left in self with indices adjusted after the removal.

impl TryFrom<BytesMut> for StrChunkMut

type Error = Utf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.