Struct runestr::rune

pub struct rune(_, _);

The rune type represents a user-perceived character.

Implementations

impl rune

pub fn from_char(ch: char) -> Option<Self>

Convert a char to rune, returning None if it could not form a complete rune.

pub fn from_char_lossy(ch: char) -> Self

Convert a char to rune, modifying text to form a complete rune if necessary. See crate documentation for more details on this.

pub fn from_grapheme_cluster(grapheme: &str) -> Option<Self>

Convert a &str consisting of a grapheme cluster to rune, returning None if the input is not exactly a grapheme cluster or it could not form a complete rune.

pub fn from_grapheme_cluster_lossy(grapheme: &str) -> Option<Self>

Convert a &str consisting of a grapheme cluster to rune, tweaking the text a little if necessary, or returning None if the input is not exactly a grapheme cluster.

pub fn from_inner(v: u32) -> Option<Self>

Constructs a rune from its internal representation.

pub fn into_inner(self) -> u32

Retrieves the internal representation of this rune.

pub fn into_char(self) -> Option<char>

Retrieves the char this rune represents. Returns None if it represents multiple chars.

pub fn into_chars(self) -> Chars

Retrieves an iterator that iterate over all the chars this rune represents.

pub fn len_runestr(self) -> usize

Returns the number of bytes this char would need if encoded in RuneStr. That number of bytes is always between 1 and 6, inclusive.

pub fn encode_runestr(self, dst: &mut [u8]) -> &mut RuneStr

Encode this rune as RuneStr into the provided byte buffer, and then returns the subslice of the buffer that contains the encoded rune.

Panics

Panics if the buffer is not large enough. A buffer of length six is large enough to encode any rune.

Trait Implementations

impl Clone for rune

fn clone(&self) -> rune

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for rune

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

Formats the value using the given formatter.

impl Default for rune

fn default() -> rune

Returns the “default value” for a type.

impl Display for rune

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

Formats the value using the given formatter.

impl Extend<rune> for RuneString

fn extend<T: IntoIterator<Item = rune>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<rune> for RuneString

fn from_iter<T: IntoIterator<Item = rune>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq<char> for rune

fn eq(&self, rhs: &char) -> 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 PartialEq<rune> for rune

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

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

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

This method tests for !=.

impl PartialEq<rune> for char

fn eq(&self, rhs: &rune) -> 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 Copy for rune

impl Eq for rune

impl StructuralEq for rune

impl StructuralPartialEq for rune