Struct basic_text::TextSubstr

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

Text substring slices.

TextSubstr is to TextSubstring as TextStr is to TextString. It is usually used for borrowing, in the form of &TextSubstr.

Implementations

impl TextSubstr

pub fn from_text_bytes(b: &[u8]) -> Result<&Self, TextError>

Converts a slice of bytes to a text string slice.

pub fn from_text(s: &str) -> Result<&Self, TextError>

Converts a string slice to a text string slice.

pub fn from_text_bytes_mut(b: &mut [u8]) -> Result<&mut Self, TextError>

Converts a mutable slice of bytes to a mutable text string slice.

pub fn from_text_mut(s: &mut str) -> Result<&mut Self, TextError>

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

pub unsafe fn from_text_bytes_unchecked(b: &[u8]) -> &Self

Converts a slice of bytes to a text string slice 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 &TextSubstrs are valid Basic Text.

pub unsafe fn from_text_unchecked(s: &str) -> &Self

Converts a string slice to a text string slice 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 &TextSubstrs are valid Basic Text.

pub unsafe fn from_text_bytes_unchecked_mut(b: &mut [u8]) -> &mut Self

Converts a slice of bytes to a text string slice without checking that the string contains valid Basic Text; mutable version.

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 &TextSubstrs are valid Basic Text.

pub unsafe fn from_text_unchecked_mut(s: &mut str) -> &mut Self

Converts a string slice to a text string slice without checking that the string contains valid Basic Text; mutable version.

Safety

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

pub unsafe fn from_boxed_text_bytes_unchecked(v: Box<[u8]>) -> Box<Self>

Converts a boxed slice of bytes to a boxed text string slice 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 &TextSubstrs are valid Basic Text.

pub unsafe fn from_boxed_text_unchecked(v: Box<str>) -> Box<Self>

Converts a boxed string slice to a boxed text string slice 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 &TextSubstrs are valid Basic Text.

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 TextSubstr is used.

Use of a TextSubstr 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_str(&self) -> &str

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

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.

TODO: There should be a TextLines which yields &TextSubstrs.

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.

TODO: There should be a TextMatches which yields &TextSubstrs.

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.

TODO: There should be a TextRMatches which yields &TextSubstrs.

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.

TODO: There should be a TextMatchIndices which yields &TextSubstrs.

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.

TODO: There should be a TextRMatchIndices which yields &TextSubstrs.

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.

pub fn into_boxed_bytes(self: Box<Self>) -> Box<[u8]>

Converts a Box<TextSubstr> into a Box<[u8]> without copying or allocating.

pub fn into_boxed_text(self: Box<Self>) -> Box<str>

Converts a Box<TextSubstr> into a Box<str> without copying or allocating.

pub fn into_string(self: Box<Self>) -> String

Converts a Box<TextSubstr> into a String without copying or allocating.

pub fn into_text_string(self: Box<Self>) -> TextSubstring

Converts a Box<TextSubstr> into a TextSubstring without copying or allocating.

pub fn repeat(&self, n: usize) -> TextSubstring

Creates a new TextSubstring by repeating a string n times.

pub fn escape_debug(&self) -> EscapeDebug<'_>

Return an iterator that escapes each char in self with char::escape_debug.

pub fn escape_default(&self) -> EscapeDefault<'_>

Return an iterator that escapes each char in self with char::escape_default.

pub fn escape_unicode(&self) -> EscapeUnicode<'_>

Return an iterator that escapes each char in self with char::escape_unicode.

Trait Implementations

impl AsMut<TextSubstr> for TextSubstring

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

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

impl AsRef<[u8]> for TextSubstr

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

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

impl AsRef<OsStr> for TextSubstr

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for TextSubstr

fn as_ref(&self) -> &Path

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

impl AsRef<TextSubstr> for TextString

fn as_ref(&self) -> &TextSubstr

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

impl AsRef<TextSubstr> for TextStr

fn as_ref(&self) -> &TextSubstr

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

impl AsRef<TextSubstr> for TextSubstring

fn as_ref(&self) -> &TextSubstr

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

impl AsRef<TextSubstr> for TextSubstr

fn as_ref(&self) -> &Self

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

impl AsRef<str> for TextSubstr

fn as_ref(&self) -> &str

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

impl Borrow<TextSubstr> for TextSubstring

fn borrow(&self) -> &TextSubstr

Immutably borrows from an owned value.

impl BorrowMut<TextSubstr> for TextSubstring

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

Mutably borrows from an owned value.

impl Clone for Box<TextSubstr>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSubstr

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

Formats the value using the given formatter.

impl Default for &TextSubstr

fn default() -> Self

Returns the “default value” for a type.

impl Default for &mut TextSubstr

fn default() -> Self

Returns the “default value” for a type.

impl Default for Box<TextSubstr>

fn default() -> Self

Returns the “default value” for a type.

impl Display for TextSubstr

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

Formats the value using the given formatter.

impl From<&'_ TextSubstr> for TextSubstring

fn from(s: &TextSubstr) -> Self

Converts to this type from the input type.

impl From<&'_ TextSubstr> for Box<TextSubstr>

fn from(s: &TextSubstr) -> Self

Converts to this type from the input type.

impl From<&'_ mut TextSubstr> for TextSubstring

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

Converts to this type from the input type.

impl From<Cow<'_, TextSubstr>> for Box<TextSubstr>

fn from(cow: Cow<'_, TextSubstr>) -> Self

Converts to this type from the input type.

impl From<TextSubstring> for Box<TextSubstr>

fn from(s: TextSubstring) -> Self

Converts to this type from the input type.

impl Hash for TextSubstr

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 Index<Range<usize>> for TextSubstr

type Output = TextSubstr

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for TextSubstr

type Output = TextSubstr

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for TextSubstr

type Output = TextSubstr

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for TextSubstr

fn cmp(&self, other: &Self) -> 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<'a> PartialEq<&'a TextSubstr> for String

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

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

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

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

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

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

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

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

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

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

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

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

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

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: &Rhs) -> bool

This method tests for !=.

impl PartialEq<TextString> for TextSubstr

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: &Rhs) -> bool

This method tests for !=.

impl PartialEq<TextSubstr> for str

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

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

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

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

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

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

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

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

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

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

This method tests for !=.

impl<'a> PartialEq<TextSubstring> for &'a TextSubstr

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

fn eq(&self, other: &TextSubstring) -> 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 TextSubstr

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<TextSubstr> for TextSubstr

fn partial_cmp(&self, other: &Self) -> 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 ToOwned for TextSubstr

type Owned = TextSubstring

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl ToSocketAddrs for TextSubstr

type Iter = IntoIter<SocketAddr, Global>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<Self::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl Eq for TextSubstr

impl StructuralEq for TextSubstr

impl StructuralPartialEq for TextSubstr