Struct PopulatedStr 

pub struct PopulatedStr(/* private fields */);

Implementations

impl PopulatedStr

pub const fn from_str_panic_if_empty(str: &str) -> &PopulatedStr

pub fn as_str(&self) -> &str

pub fn len(&self) -> NonZeroUsize

Returns the length of self.

This length is in bytes, not chars or graphemes. In other words, it might not be what a human considers the length of the string.

pub fn is_char_boundary(&self, index: usize) -> bool

pub fn split_at_populated(&self, mid: NonZeroUsize) -> (&PopulatedStr, &str)

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

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

Returns a populated iterator over the chars of a string slice.

pub fn to_lowercase(&self) -> PopulatedString

Returns the lowercase equivalent of this PopulatedStr slice, as a new PopulatedString.

‘Lowercase’ is defined according to the terms of the Unicode Derived Core Property Lowercase.

Since some characters can expand into multiple characters when changing the case, this function returns a PopulatedString instead of modifying the parameter in-place.

pub fn to_uppercase(&self) -> PopulatedString

Returns the uppercase equivalent of this PopulatedStr slice, as a new PopulatedString.

‘Uppercase’ is defined according to the terms of the Unicode Derived Core Property Uppercase.

Since some characters can expand into multiple characters when changing the case, this function returns a PopulatedString instead of modifying the parameter in-place.

pub fn repeat(&self, n: NonZeroUsize) -> PopulatedString

Creates a new PopulatedString by repeating a string n times. n must be greater than 0 to preserve populatedness.

pub fn trim(&self) -> &str

Returns a string slice with leading and trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

pub fn trim_start(&self) -> &str

Returns a string slice with leading whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

pub fn trim_end(&self) -> &str

Returns a string slice with trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

Trait Implementations

impl Add<&PopulatedStr> for String

type Output = PopulatedString

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&PopulatedStr> for PopulatedString

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

Performs the += operation.

impl AsMut<PopulatedStr> for PopulatedString

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

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

impl AsRef<PopulatedStr> for PopulatedString

fn as_ref(&self) -> &PopulatedStr

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

impl AsRef<str> for PopulatedStr

fn as_ref(&self) -> &str

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

impl Borrow<PopulatedStr> for PopulatedString

fn borrow(&self) -> &PopulatedStr

Immutably borrows from an owned value.

impl Borrow<str> for PopulatedStr

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl BorrowMut<PopulatedStr> for PopulatedString

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

Mutably borrows from an owned value.

impl Debug for PopulatedStr

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

Formats the value using the given formatter.

impl<'a> Extend<&'a PopulatedStr> for PopulatedString

fn extend<T: IntoIterator<Item = &'a PopulatedStr>>(&mut self, iter: T)

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> Extend<&'a PopulatedStr> for String

fn extend<T: IntoIterator<Item = &'a PopulatedStr>>(&mut self, iter: T)

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 PopulatedStr> for &'a str

fn from(populated_str: &'a PopulatedStr) -> &'a str

Converts to this type from the input type.

impl From<&PopulatedStr> for PopulatedString

fn from(populated_str: &PopulatedStr) -> PopulatedString

Converts to this type from the input type.

impl<'a> From<&'a mut PopulatedStr> for &'a mut str

fn from(populated_str: &'a mut PopulatedStr) -> &'a mut str

Converts to this type from the input type.

impl<'a> FromPopulatedIterator<&'a PopulatedStr> for PopulatedString

fn from_populated_iter( iter: impl IntoPopulatedIterator<Item = &'a PopulatedStr>, ) -> Self

Converts a PopulatedIterator into Self.

impl Hash for PopulatedStr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl Ord for PopulatedStr

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

This method returns an Ordering between self and other.

impl PartialEq<PopulatedStr> for str

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

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 PopulatedStr

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

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

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

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 ToOwned for PopulatedStr

type Owned = PopulatedString

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<'a> TryFrom<&'a mut str> for &'a mut PopulatedStr

type Error = UnpopulatedError

The type returned in the event of a conversion error.

fn try_from( string: &'a mut str, ) -> Result<&'a mut PopulatedStr, UnpopulatedError>

Performs the conversion.

impl<'a> TryFrom<&'a str> for &'a PopulatedStr

type Error = UnpopulatedError

The type returned in the event of a conversion error.

fn try_from(string: &'a str) -> Result<&'a PopulatedStr, UnpopulatedError>

Performs the conversion.

impl Eq for PopulatedStr

impl StructuralPartialEq for PopulatedStr