Struct TokenString

#[repr(C)]
pub struct TokenString { /* private fields */ }

A string which can hold at most MAX_LENGTH bytes (not Unicode scalar values).

This holds valid UTF-8 encoded strings only. Strings that are short enough, which need at most MAX_LENGTH_SMALL bytes, are stored in the struct itself, bigger ones use the heap.

Invariant

• TokenString must be a UTF-8 string (like &str and alloc::string::String).
• The length of a TokenString is at most MAX_LENGTH and at least 0 - the empty string.

Implementations

impl TokenString

pub const fn len(&self) -> usize

Return the length of the string in bytes.

This is the length of the string in bytes, not Unicode scalar values and not grapheme clusters.

pub const fn is_small(&self) -> bool

Return true if the string is a “small string”, that is, it is saved in the TokenString struct itself.

If this returns false, the string is allocated on the heap.

pub const fn is_empty(&self) -> bool

Return true, if this is the empty string.

Returns false else.

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> Self

Convert to a TokenString.

bytes must be valid UTF-8, use TokenString::try_from if you are not sure that it is valid. If the given byte slice is bigger than MAX_LENGTH, this panics.

Memory:

Allocates if and only if the length of bytes is bigger than MAX_LENGTH_SMALL.

Panics

Panics if bytes is bigger than MAX_LENGTH.

Safety

bytes must be valid UTF-8, if not, all bets are off - UB!

pub fn from_str_unchecked(s: &str) -> Self

Convert to a TokenString.

If the given string s is bigger than MAX_LENGTH, this panics. Use TokenString::try_from for a function that does not panic. The string s must be valid UTF-8 too, but it has already been UB if it isn’t.

Memory:

Allocates if and only if the length of s is bigger than MAX_LENGTH_SMALL.

Panics

Panics if s is bigger than MAX_LENGTH.

pub fn from_string_unchecked(s: &String) -> Self

Convert to a TokenString.

If the given string s is bigger than MAX_LENGTH, this panics. Use TokenString::try_from for a function that does not panic. The string s must be valid UTF-8 too, but it has already been UB if it isn’t.

Memory:

Allocates if and only if the length of s is bigger than MAX_LENGTH_SMALL.

Panics

Panics if s is bigger than MAX_LENGTH.

pub fn as_str(&self) -> &str

Return the string as a &str.

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

Return the string as a byte slice.

pub fn as_string(&self) -> String

Return the string as a new alloc::string::String.

Memory:

Allocates a new alloc::string::String.

pub fn as_chars(&self) -> Vec<char>

Return the string as a new vector of chars.

Memory:

Allocates a new vec::Vec.

pub fn get(&self, idx: u16) -> Result<u8, TkStrError>

Return the byte at index idx, check bounds.

Returns TkStrError::OutOfBounds if the index is bigger than the string’s length.

Errors

TkStrError::OutOfBounds if idx is bigger than the string’s length.

pub fn get_unchecked(&self, idx: u16) -> u8

Return the byte at index idx, don’t check bounds.

Panics if the index is bigger than the string’s length.

Panics

if idx is bigger than the string’s length.

pub fn chars(&self) -> Chars<'_>

Return an iterator over the [char]s of a string.

That is, an iterator over the Unicode scalar values of the TokenString.

pub fn iter(&self) -> TokenStringIter<'_>

Get a reference iterator.

pub const fn starts_ascii_uppercase(&self) -> bool

Return true, if the first byte is an uppercase ASCII character.

pub const fn starts_ascii_lowercase(&self) -> bool

Return true, if the first byte is an lowercase ASCII character.

pub fn is_ascii(&self) -> bool

Return true, if the string contains only ASCII characters.

pub fn starts_with(&self, needle: &Self) -> bool

Return true, if the string starts with needle.

Returns true too if the string is needle.

pub fn starts_with_bytes(&self, needle: &[u8]) -> bool

Return true, if the string starts with needle.

Returns true too if the string is needle.

pub fn starts_with_str(&self, needle: &str) -> bool

Return true, if the string starts with needle.

Returns true too if the string is needle.

pub fn ends_with(&self, needle: &Self) -> bool

Return true, if the string ends with needle.

Returns true too if the string is needle.

pub fn ends_with_bytes(&self, needle: &[u8]) -> bool

Return true, if the string ends with needle.

Returns true too if the string is needle.

pub fn ends_with_str(&self, needle: &str) -> bool

Return true, if the string ends with needle.

Returns true too if the string is needle.

pub fn to_ascii_lowercase(&self) -> Self

Return a new string with all uppercase ASCII characters changed to lowercase.

pub fn to_ascii_uppercase(&self) -> Self

Return a new string with all lowercase ASCII characters changed to uppercase.

pub fn trim_ascii(&self) -> Self

Return a new string with all ASCII whitespace removed from the start and end.

pub fn trim_ascii_start(&self) -> Self

Return a new string with all ASCII whitespace removed from the start.

pub fn trim_ascii_end(&self) -> Self

Return a new string with all ASCII whitespace removed from the end.

pub fn strip_prefix<P: Pattern>(&self, prefix: P) -> Option<Self>

Available on pattern only.

Return a new string with prefix removed from the start.

pub fn strip_suffix<P>(&self, suffix: P) -> Option<Self>

where P: Pattern, for<'a> P::Searcher<'a>: ReverseSearcher<'a>,

Available on pattern only.

Return a new string with suffix removed from the end.

pub fn contains<P: Pattern>(&self, pat: P) -> bool

Available on pattern only.

Return true if the string contains the pattern pat.

Returns false else.

The feature

Trait Implementations

impl AsRef<str> for TokenString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for TokenString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for TokenString

fn clone(&self) -> Self

Return a clone of the TokenString.

Memory:

Allocates if and only if the length of value is bigger than MAX_LENGTH_SMALL.

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

Performs copy-assignment from source.

impl<'a, const N: usize> Concat<&'a TokenString> for &'a mut Builder<'a, N>

type Output = &'a mut Builder<'a, N>

fn concat(self, s: &'a TokenString) -> Result<Self::Output, TkStrError>

Concatenate another string to the end of the builder.

impl<'a, const N: usize> Concat<&'a TokenString> for Result<&'a mut Builder<'a, N>, TkStrError>

type Output = &'a mut Builder<'a, N>

fn concat(self, s: &'a TokenString) -> Result<Self::Output, TkStrError>

Concatenate another string to the end of the builder.

impl Debug for TokenString

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

Formats the value using the given formatter.

impl Default for TokenString

fn default() -> Self

Return the empty string.

impl Display for TokenString

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

Formats the value using the given formatter.

impl Drop for TokenString

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for TokenString

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<Idx> Index<Idx> for TokenString

where Idx: SliceIndex<str>,

type Output = <Idx as SliceIndex<str>>::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a TokenString

type IntoIter = TokenStringIter<'a>

Which kind of iterator are we turning this into?

type Item = u8

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for TokenString

type IntoIter = TokenStringIterOwn

Which kind of iterator are we turning this into?

type Item = u8

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for TokenString

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

Compare two TokenStrings byte-wise.

This is not a sensible alphabetical comparison for anything that isn’t ASCII.

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 PartialEq<[u8]> for TokenString

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

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

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

fn eq(&self, other: &Self) -> 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 PartialOrd for TokenString

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

Compare two TokenStrings byte-wise.

This is not a sensible alphabetical comparison for anything that isn’t ASCII.

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 TryFrom<&[char]> for TokenString

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

Try to create a TokenString from the given slice.

Return TkStrError::TooBig if the given slice is too big, greater than MAX_LENGTH.

Memory

Allocates and deallocates a temporary alloc::string::String collecting the converted bytes.

type Error = TkStrError

The type returned in the event of a conversion error.

impl TryFrom<&[u8]> for TokenString

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

Try to create a TokenString from the given slice.

Return TkStrError::TooBig if the given slice is too big, greater than MAX_LENGTH. Return TkStrError::UnicodeError

Memory:

Allocates if and only if the length of value is bigger than MAX_LENGTH_SMALL.

type Error = TkStrError

The type returned in the event of a conversion error.

impl TryFrom<&String> for TokenString

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

Create a TokenString from a &alloc::string::String.

Return TkStrError::TooBig if the argument is greater than MAX_LENGTH.

Memory:

Allocates if and only if the length of value is bigger than MAX_LENGTH_SMALL.

type Error = TkStrError

The type returned in the event of a conversion error.

impl TryFrom<&str> for TokenString

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

Create a TokenString from a &str.

Return TkStrError::TooBig if the argument is greater than MAX_LENGTH.

Memory:

Allocates if and only if the length of value is bigger than MAX_LENGTH_SMALL.

type Error = TkStrError

The type returned in the event of a conversion error.

impl TryFrom<String> for TokenString

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

Create a TokenString from a alloc::string::String.

Return TkStrError::TooBig if the argument is greater than MAX_LENGTH.

Memory:

Allocates if and only if the length of value is bigger than MAX_LENGTH_SMALL.

type Error = TkStrError

The type returned in the event of a conversion error.

impl Eq for TokenString

impl Send for TokenString

impl Sync for TokenString