Struct unsegen::base::grapheme_cluster::GraphemeCluster

pub struct GraphemeCluster { /* fields omitted */ }

A single grapheme cluster encoded in utf8. It may consist of multiple bytes or even multiple chars. For details on what a grapheme cluster is, read this or similar.

Implementations

impl GraphemeCluster

pub fn as_str<'a>(&'a self) -> &'a str

Get the underlying grapheme cluster as a String slice.

Examples:

use unsegen::base::GraphemeCluster;
assert_eq!(GraphemeCluster::try_from('a').unwrap().as_str(), "a");

pub fn space() -> Self

Safely create a single space character (i.e., 0x20) grapheme cluster.

Examples:

use unsegen::base::GraphemeCluster;
assert_eq!(GraphemeCluster::space().as_str(), " ");

pub fn clear(&mut self)

Replace the current cluster with a single space character (i.e., 0x20)

Examples:

use unsegen::base::GraphemeCluster;
let mut cluster = GraphemeCluster::try_from('a').unwrap();
cluster.clear();
assert_eq!(cluster.as_str(), " ");

pub fn try_from(c: char) -> Result<Self, GraphemeClusterError>

Try to create a grapheme cluster from a character. If c is not a single grapheme cluster, a GraphemeClusterError is returned.

Examples:

use unsegen::base::GraphemeCluster;
assert_eq!(GraphemeCluster::try_from('a').unwrap().as_str(), "a");

pub fn all_from_str<'a>(string: &'a str) -> GraphemeClusterIter<'a>

Retrieve all grapheme clusters from the given string.

Examples:

use unsegen::base::GraphemeCluster;
let mut clusters = GraphemeCluster::all_from_str("ab d");
assert_eq!(clusters.next(), Some(GraphemeCluster::try_from('a').unwrap()));
assert_eq!(clusters.next(), Some(GraphemeCluster::try_from('b').unwrap()));
assert_eq!(clusters.next(), Some(GraphemeCluster::try_from(' ').unwrap()));
assert_eq!(clusters.next(), Some(GraphemeCluster::try_from('d').unwrap()));
assert_eq!(clusters.next(), None);

pub fn width(&self) -> usize

Calculate the unicode width of the given grapheme cluster.

Examples:

use unsegen::base::GraphemeCluster;
assert_eq!(GraphemeCluster::try_from('a').unwrap().width(), 1);

Trait Implementations

impl Clone for GraphemeCluster

fn clone(&self) -> GraphemeCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GraphemeCluster

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

Formats the value using the given formatter.

impl FromStr for GraphemeCluster

type Err = GraphemeClusterError

The associated error which can be returned from parsing.

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

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

impl PartialEq<GraphemeCluster> for GraphemeCluster

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

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

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

This method tests for !=.

impl StructuralPartialEq for GraphemeCluster