Struct NonEmptyString

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

A simple String wrapper type, similar to NonZeroUsize and friends. Guarantees that the String contained inside is not of length 0.

Implementations

impl NonEmptyString

pub fn new(string: String) -> Result<Self, String>

Attempts to create a new NonEmptyString. If the given string is empty, Err is returned, containing the original String, Ok otherwise.

pub unsafe fn new_unchecked(string: String) -> Self

Creates a new NonEmptyString, assuming string is not empty.

Safety

If the given string is empty, it’ll be undefined behavior.

pub fn get(&self) -> &str

Returns a reference to the contained value.

pub fn into_inner(self) -> String

Consume the NonEmptyString to get the internal String out.

pub fn into_bytes(self) -> Vec<u8>

Is forwarded to the inner String. See String::into_bytes

pub fn as_str(&self) -> &str

Is forwarded to the inner String. See String::as_str

pub fn push_str(&mut self, string: &str)

Is forwarded to the inner String. See String::push_str

pub fn capacity(&self) -> usize

Is forwarded to the inner String. See String::capacity

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

Is forwarded to the inner String. See String::reserve

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

Is forwarded to the inner String. See String::reserve_exact

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

Is forwarded to the inner String. See String::try_reserve_exact

pub fn shrink_to_fit(&mut self)

Is forwarded to the inner String. See std::string::String::[(&]

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

Is forwarded to the inner String. See String::shrink_to

pub fn push(&mut self, ch: char)

Is forwarded to the inner String. See String::push

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

Is forwarded to the inner String. See String::as_bytes

pub fn insert(&mut self, idx: usize, ch: char)

Is forwarded to the inner String. See String::insert

pub fn insert_str(&mut self, idx: usize, string: &str)

Is forwarded to the inner String. See String::insert_str

pub fn len(&self) -> usize

Is forwarded to the inner String. See String::len

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

Is forwarded to the inner String. See String::into_boxed_str

Trait Implementations

impl Add<&str> for NonEmptyString

type Output = NonEmptyString

The resulting type after applying the + operator.

fn add(self, other: &str) -> NonEmptyString

Performs the + operation.

impl AddAssign<&str> for NonEmptyString

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

Performs the += operation.

impl AsRef<String> for NonEmptyString

fn as_ref(&self) -> &String

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

impl AsRef<str> for NonEmptyString

fn as_ref(&self) -> &str

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

impl Borrow<String> for NonEmptyString

fn borrow(&self) -> &String

Immutably borrows from an owned value.

impl Borrow<str> for NonEmptyString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for NonEmptyString

fn clone(&self) -> NonEmptyString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonEmptyString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NonEmptyString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NonEmptyString

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

Formats the value using the given formatter.

impl<'a> Extend<&'a char> for NonEmptyString

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

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

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

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

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl Extend<Box<str>> for NonEmptyString

fn extend<I: IntoIterator<Item = Box<str>>>(&mut self, iter: I)

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl<'a> Extend<Cow<'a, str>> for NonEmptyString

fn extend<I: IntoIterator<Item = Cow<'a, str>>>(&mut self, iter: I)

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl Extend<String> for NonEmptyString

fn extend<I: IntoIterator<Item = String>>(&mut self, iter: I)

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl Extend<char> for NonEmptyString

fn extend<I: IntoIterator<Item = char>>(&mut self, iter: I)

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 #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

impl From<NonEmptyString> for String

fn from(value: NonEmptyString) -> Self

Converts to this type from the input type.

impl From<char> for NonEmptyString

fn from(c: char) -> Self

Converts to this type from the input type.

impl FromStr for NonEmptyString

type Err = <NonEmptyString as TryFrom<String>>::Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NonEmptyString

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

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for NonEmptyString

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for NonEmptyString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeFull) -> &str

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for NonEmptyString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for NonEmptyString

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for NonEmptyString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl Ord for NonEmptyString

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

This method returns an Ordering between self and other.

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<'a, 'b> PartialEq<&'a str> for NonEmptyString

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

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

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

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

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

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

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<'a, 'b> PartialEq<str> for NonEmptyString

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 NonEmptyString

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

fn partial_cmp(&self, other: &NonEmptyString) -> 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 Serialize for NonEmptyString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'s> TryFrom<&'s str> for NonEmptyString

type Error = &'s str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for NonEmptyString

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Write for NonEmptyString

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Eq for NonEmptyString

impl StructuralPartialEq for NonEmptyString