Struct andiskaz::string::TermString

pub struct TermString { /* fields omitted */ }

Graphical string: a string valid to be printed on a terminal for graphic purpouse.

Implementations

impl TermString

pub fn new<S>(string: S) -> Result<Self, TermStringError> where
    S: AsRef<str>, 

Builds a new graphical string.

The string must not start with a diacritic character. Diacritic here is not “^” or “~”, but rather a diacritic that when inserted combines with the previous character. Like the tilde in “ỹ” which can be separated from “y”. On the other hand, the combination “ỹ” is valid and forms a single grapheme cluster. The diacritic is only invalid when separated.

Control characters also trigger an error, because those would allow the terminal to be controlled.

pub fn new_lossy<S>(string: S) -> Self where
    S: AsRef<str>, 

Creates a new TermString, but replaces error with the replacement character “�”.

pub fn count_graphemes(&self) -> usize

Counts how many grapheme clusters the string contains by iterating the string.

pub fn as_str(&self) -> &str

Converts into a reference to a plain string.

pub fn get<I>(&self, index: I) -> Option<I::Output> where
    I: Index, 

Indexes the string by returning None if out of bounds. usize will return TermGraphemes, ranges will return sub-TermStrings. WARNING: this method is, prefere iterating instead.

pub fn index<I>(&self, index: I) -> I::Output where
    I: Index, 

Indexes the string by panicking if out of bounds. usize will return TermGraphemes, ranges will return sub-TermStrings. WARNING: this method is slow, prefere iterating instead.

pub fn indices(&self) -> TermStringIndices<'_>

Iterates over indices and grapheme clusters of this string.

pub fn iter(&self) -> TermStringIter<'_>

Iterates only over graphemes of this string.

pub fn full_buf(self) -> Self

De-slices a sub-TermString into the original buffer.

Trait Implementations

impl AsRef<Path> for TermString

fn as_ref(&self) -> &Path

Performs the conversion.

impl<'buf> AsRef<TermString> for StringOrGraphm<'buf>

fn as_ref(&self) -> &TermString

Performs the conversion.

impl AsRef<str> for TermString

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for TermString

fn clone(&self) -> TermString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TermString

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

Formats the value using the given formatter.

impl Default for TermString

fn default() -> Self

Returns the “default value” for a type.

impl Deref for TermString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for TermString

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

Formats the value using the given formatter.

impl<'buf> From<&'buf TermString> for StringOrGraphm<'buf>

fn from(tstring: &'buf TermString) -> StringOrGraphm<'buf>

Performs the conversion.

impl<'buf> FromIterator<&'buf TermGrapheme> for TermString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'buf TermGrapheme>, 

Creates a value from an iterator.

impl<'buf> FromIterator<&'buf TermString> for TermString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'buf TermString>, 

Creates a value from an iterator.

impl<'buf> FromIterator<StringOrGraphm<'buf>> for TermString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = StringOrGraphm<'buf>>, 

Creates a value from an iterator.

impl FromIterator<TermGrapheme> for TermString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = TermGrapheme>, 

Creates a value from an iterator.

impl FromIterator<TermString> for TermString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = TermString>, 

Creates a value from an iterator.

impl Hash for TermString

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

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<'tstring> IntoIterator for &'tstring TermString

type Item = TermGrapheme

The type of the elements being iterated over.

type IntoIter = TermStringIter<'tstring>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl MenuOption for TermString

fn name(&self) -> TermString

Returns the display name of this option.

impl Ord for TermString

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

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

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<'buf> TryFrom<&'buf str> for TermString

type Error = TermStringError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for TermString

type Error = TermStringError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for TermString