Struct basic_text::TextString

#[repr(transparent)]pub struct TextString(_);

A Basic Text encoded, growable string.

Implementations

impl TextString

#[must_use]pub const fn new() -> Self

Creates a new empty TextString.

#[must_use]pub fn with_capacity(capacity: usize) -> Self

Creates a new empty TextString with a particular capacity.

pub fn from_text_vec(vec: Vec<u8>) -> Result<Self, FromTextError>

Converts a vector of bytes to a TextString.

pub fn from_text(s: String) -> Result<Self, FromTextError>

Converts a String to a TextString.

#[must_use]pub fn from_text_bytes_lossy(v: &[u8]) -> Cow<'_, TextStr>

Converts a slice of bytes to Basic Text, including invalid characters.

#[must_use]pub fn from_text_lossy(v: &str) -> Cow<'_, TextStr>

Converts a string to Basic Text, including invalid characters.

#[must_use]pub unsafe fn from_text_vec_unchecked(vec: Vec<u8>) -> Self

Converts a vector of bytes to a TextString without checking that the string contains valid Basic Text.

Safety

This function is unsafe because it does not check that the bytes passed to it are valid Basic Text. If this constraint is violated, undefined behavior results, as the rest of this crate assumes that &TextStrs are valid Basic Text.

#[must_use]pub const unsafe fn from_text_unchecked(s: String) -> Self

Converts a String to a TextString without checking that the string contains valid Basic Text.

Safety

This function is unsafe because it does not check that the bytes passed to it are valid Basic Text. If this constraint is violated, undefined behavior results, as the rest of this crate assumes that &TextStrs are valid Basic Text.

#[must_use]pub fn into_utf8(self) -> String

Converts a TextString into a String.

#[must_use]pub fn into_bytes(self) -> Vec<u8>

Converts a String into a byte vector.

#[must_use]pub fn as_utf8(&self) -> &str

Extracts a UTF-8 string slice containing the entire TextString.

#[must_use]pub fn as_str(&self) -> &TextStr

Extracts a Basic Text string slice containing the entire TextString.

#[must_use]pub fn as_mut_utf8(&mut self) -> &mut str

Converts a TextString into a mutable UTF-8 string slice.

#[must_use]pub fn as_mut_str(&mut self) -> &mut TextStr

Converts a TextString into a mutable Basic Text string slice.

pub fn push_str(&mut self, s: &TextStr)

Appends a given string slice onto the end of this TextString.

But wait, NFC isn’t closed under concatenation! This is true, but Basic Text has additional restrictions, including that strings start with non-combining codepoints, so it is closed under concatenation.

#[must_use]pub fn capacity(&self) -> usize

Returns this TextString’s capacity, in bytes.

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

Ensures that this TextString’s capacity is at least additional bytes larger than its length.

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

Ensures that this TextString’s capacity is additional bytes larger than its length.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more elements to be inserted in the given TextString.

pub fn try_reserve_exact(
    &mut self,
    additional: usize
) -> Result<(), TryReserveError>

Tries to reserves the minimum capacity for exactly additional more elements to be inserted in the given TextString.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of this TextString to match its length.

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity of this String with a lower bound.

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

Returns a byte slice of this TextString’s contents.

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

Returns a mutable reference to the contents of this TextString.

Safety

This function is unsafe because it does not check that the bytes passed to it are valid Basic Text. If this constraint is violated, it may cause memory unsafety issues with future users of the String, as the rest of this crate assumes that TextStrings are valid Basic Text.

pub fn len(&self) -> usize

Returns the length of this TextString, in bytes, not chars or graphemes.

pub fn is_empty(&self) -> bool

Returns true if this TextString has a length of zero, and false otherwise.

pub fn clear(&mut self)

Truncates this String, removing all contents.

pub fn into_boxed_utf8(self) -> Box<str>

Converts this TextString into a Box<str>.

pub fn into_boxed_str(self) -> Box<TextStr>

Converts this TextString into a Box<TextStr>.

Methods from Deref<Target = TextStr>

pub const fn len(&self) -> usize

Returns the length of self.

pub const fn is_empty(&self) -> bool

Returns true if self has a length of zero bytes.

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

Converts a text string slice to a byte slice.

pub unsafe fn as_bytes_mut(&mut self) -> &mut [u8]

Converts a mutable text string slice to a mutable byte slice.

Safety

The caller must ensure that the content of the slice is valid Basic Text before the borrow ends and the underlying TextStr is used.

Use of a TextStr whose contents are not valid Basic Text is undefined behavior.

pub const fn as_ptr(&self) -> *const u8

Converts a text string slice to a raw pointer.

pub fn as_mut_ptr(&mut self) -> *mut u8

Converts a mutable text string slice to a raw pointer.

pub fn as_utf8(&self) -> &str

Extracts a UTF-8 string slice containing the entire TextStr.

pub fn split_at(&self, mid: usize) -> (&Self, &Self)

Divide one text string slice into two at an index.

pub fn split_at_mut(&mut self, mid: usize) -> (&mut Self, &mut Self)

Divide one mutable text string slice into two at an index.

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

Returns an iterator over the chars of a text string slice.

pub fn char_indices(&self) -> CharIndices<'_>

Returns an iterator over the chars of a text string slice, and their positions.

pub fn bytes(&self) -> Bytes<'_>

An iterator over the bytes of a text string slice.

pub fn lines(&self) -> Lines<'_>

An iterator over the lines of a text string, as text string slices.

pub fn encode_utf16(&self) -> EncodeUtf16<'_>

Returns an iterator of u16 over the string encoded as Basic Text.

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

Returns true if the given pattern matches a sub-slice of this text string slice.

Returns false if it does not.

pub fn starts_with<'a, P>(&'a self, pat: P) -> bool where
    P: Pattern<'a>, 

Returns true if the given pattern matches a prefix of this text string slice.

Returns false if it does not.

pub fn ends_with<'a, P>(&'a self, pat: P) -> bool where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: ReverseSearcher<'a>, 

Returns true if the given pattern matches a suffix of this text string slice.

Returns false if it does not.

pub fn find<'a, P>(&'a self, pat: P) -> Option<usize> where
    P: Pattern<'a>, 

Returns the byte index of the first character of this text string slice that matches the pattern.

Returns None if the pattern doesn’t match.

pub fn rfind<'a, P>(&'a self, pat: P) -> Option<usize> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: ReverseSearcher<'a>, 

Returns the byte index for the first character of the rightmost match of the pattern in this text string slice.

Returns None if the pattern doesn’t match.

pub fn matches<'a, P>(&'a self, pat: P) -> Matches<'a, P> where
    P: Pattern<'a>, 

An iterator over the disjoint matches of a pattern within the given text string slice.

pub fn rmatches<'a, P>(&'a self, pat: P) -> RMatches<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: ReverseSearcher<'a>, 

An iterator over the disjoint matches of a pattern within this text string slice, yielded in reverse order.

pub fn match_indices<'a, P>(&'a self, pat: P) -> MatchIndices<'a, P> where
    P: Pattern<'a>, 

An iterator over the disjoint matches of a pattern within this text string slice as well as the index that the match starts at.

pub fn rmatch_indices<'a, P>(&'a self, pat: P) -> RMatchIndices<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: ReverseSearcher<'a>, 

An iterator over the disjoint matches of a pattern within self, yielded in reverse order along with the index of the match.

pub fn trim(&self) -> &Self

Returns a text string slice with leading and trailing whitespace removed.

pub fn trim_start(&self) -> &Self

Returns a text string slice with leading whitespace removed.

pub fn trim_end(&self) -> &Self

Returns a text string slice with trailing whitespace removed.

pub fn parse<F>(&self) -> Result<F, <F as FromStr>::Err> where
    F: FromStr, 

Parses this text string slice into another type.

pub fn is_ascii(&self) -> bool

Checks if all characters in this text string are within the ASCII range.

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

Checks that two text strings are an ASCII case-insensitive match.

Trait Implementations

impl Add<&'_ TextStr> for TextString

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &TextStr) -> Self::Output

Performs the + operation.

impl AddAssign<&'_ TextStr> for TextString

fn add_assign(&mut self, other: &TextStr)

Performs the += operation.

impl AsMut<TextStr> for TextString

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

Performs the conversion.

impl AsRef<[u8]> for TextString

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

Performs the conversion.

impl AsRef<OsStr> for TextString

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for TextString

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<TextStr> for TextString

fn as_ref(&self) -> &TextStr

Performs the conversion.

impl AsRef<str> for TextString

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<TextStr> for TextString

fn borrow(&self) -> &TextStr

Immutably borrows from an owned value.

impl BorrowMut<TextStr> for TextString

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

Mutably borrows from an owned value.

impl Clone for TextString

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextString

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

Formats the value using the given formatter.

impl Default for TextString

fn default() -> Self

Returns the “default value” for a type.

impl Deref for TextString

type Target = TextStr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for TextString

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for TextString

impl From<&'_ TextStr> for TextString

fn from(s: &TextStr) -> Self

Performs the conversion.

impl From<&'_ TextString> for TextString

fn from(s: &TextString) -> Self

Performs the conversion.

impl From<&'_ mut TextStr> for TextString

fn from(s: &mut TextStr) -> Self

Performs the conversion.

impl From<Box<TextStr, Global>> for TextString

fn from(s: Box<TextStr>) -> Self

Performs the conversion.

impl Hash for TextString

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<'a> PartialEq<&'a TextStr> for TextString

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

fn eq(&self, other: &Cow<'a, TextStr>) -> 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<'a> PartialEq<String> for TextString

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

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

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

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

This method tests for !=.

impl<'a> PartialEq<str> for TextString

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 StructuralEq for TextString

impl StructuralPartialEq for TextString