Struct andiskaz::string::TermGrapheme

pub struct TermGrapheme { /* fields omitted */ }

A grapheme cluster. Represents what a human visually sees as a character.

Implementations

impl TermGrapheme

pub fn new<S>(string: S) -> Result<Self, TermGraphemeError> where
    S: AsRef<str> + Into<String>, 

Builds a new grapheme cluster. The argument must be composed of only one grapheme.

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. 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: Into<String> + AsRef<str>, 

Creates a new TermGrapheme, but replaces error with the replacement character “�”. Truncates the string it contains more than one grapheme.

pub fn space() -> TermGrapheme

Returns the grapheme for the space “ “. This is the default grapheme, used in Default.

pub fn as_str(&self) -> &str

Converts into a reference of a plain string.

pub fn as_tstring(&self) -> &TermString

Returns the underlying string buffer of this TermGrapheme.

pub fn into_tstring(self) -> TermString

Converts into the underlying string buffer of this TermGrapheme.

Trait Implementations

impl Clone for TermGrapheme

fn clone(&self) -> TermGrapheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TermGrapheme

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

Formats the value using the given formatter.

impl Default for TermGrapheme

fn default() -> Self

Returns the grapheme for the space “ “.

impl Deref for TermGrapheme

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for TermGrapheme

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

Formats the value using the given formatter.

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

fn from(grapheme: &'buf TermGrapheme) -> 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 FromIterator<TermGrapheme> for TermString

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

Creates a value from an iterator.

impl Hash for TermGrapheme

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TermGrapheme

fn cmp(&self, other: &TermGrapheme) -> 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<TermGrapheme> for TermGrapheme

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TermGrapheme> for TermGrapheme

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

type Error = TermGraphemeError

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 TermGrapheme

type Error = TermGraphemeError

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 TermGrapheme

impl StructuralEq for TermGrapheme

impl StructuralPartialEq for TermGrapheme