Struct non_empty_string::NonEmptyString

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

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<NonEmptyString, String>

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

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.

Trait Implementations

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 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 Ord for NonEmptyString

fn cmp(&self, other: &NonEmptyString) -> 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) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NonEmptyString> for NonEmptyString

fn eq(&self, other: &NonEmptyString) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<NonEmptyString> 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

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<'s> TryFrom<&'s str> for NonEmptyString

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for NonEmptyString

impl StructuralEq for NonEmptyString

impl StructuralPartialEq for NonEmptyString