Struct NonEmptyString 

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

A string that is guaranteed to contain at least one element.

NonEmptyString provides a safe wrapper around String that maintains the invariant that the string can never be empty.

Examples

use non_non_full::NonEmptyString;

let string = "Hello, World!".to_owned();
let non_empty = NonEmptyString::new(string).unwrap();

// Empty String returns None
assert!(NonEmptyString::new(String::new()).is_none());

Implementations

impl NonEmptyString

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

Creates a new NonEmptyString from a String. Returns None if the input String is empty.

pub fn as_string(&self) -> &String

Gets a reference to the underlying String

pub fn into_string(self) -> String

Converts the NonEmptyString back into a String, consuming self

pub fn as_str(&self) -> &str

Returns a string slice containing the entire string

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

Pushes a char onto the end of the string

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

Pushes a string slice onto the end of the string

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

Inserts a char at the given byte index

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

Inserts a string slice at the given byte index

pub fn remove(&mut self, idx: usize) -> Option<char>

Removes the char at the given byte index.

Returns None if removing would make the string empty.

pub fn pop(&mut self) -> Option<char>

Removes the last char from the string.

Returns None if this would make the string empty.

pub fn len(&self) -> usize

Returns the length of the string in bytes

pub fn clear_except_first(&mut self)

Clears all chars except the first one

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

Returns an iterator over the chars in the string

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

Returns an iterator over the char indices in the string

Trait Implementations

impl Clone for NonEmptyString

fn clone(&self) -> NonEmptyString

Returns a duplicate 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 Eq for NonEmptyString

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NonEmptyString