Struct MaybeMarkerCodepoint

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

A value which is either char or a special marker.

Implementations

impl MaybeMarkerCodepoint

pub const MAX_LEN_UTF8: usize = 4usize

The maximum length of this value, when encoded as UTF8.

Currently 4 bytes, the same as char::MAX_LEN_UTF8.

pub fn from_u32(x: u32) -> Option<Self>

Create this value from a u32, returning None if invalid.

pub fn from_char(c: char) -> Self

Convert from a standard character.

Cannot fail.

pub unsafe fn from_u32_unchecked(u: u32) -> Self

Create this value from a raw u32, without checking for validity.

Safety

Undefined behavior if neither a valid character nor a marker.

pub fn to_char(&self) -> Result<char, SpecialMarker>

Convert this value into a char, returning the corresponding marker value otherwise.

pub fn to_marker(&self) -> Result<SpecialMarker, char>

Convert this value into a SpecialMarker value, returning a char otherwise.

pub fn encode_utf8(&self, output: &mut [u8]) -> usize

UTF8 encode this character into a buffer, returning the number of characters which were written.

Differs from char::encode_utf8, because marker characters are encoded specially as the corresponding SpecialMarker::utf8_marker.

Panics

Panics if there is insufficient space to encode this value. Using Self::MAX_LEN_UTF8 bytes of space is always sufficient.

Trait Implementations

impl Clone for MaybeMarkerCodepoint

fn clone(&self) -> MaybeMarkerCodepoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaybeMarkerCodepoint

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

Formats the value using the given formatter.

impl From<SpecialMarker> for MaybeMarkerCodepoint

fn from(value: SpecialMarker) -> Self

Converts to this type from the input type.

impl From<char> for MaybeMarkerCodepoint

fn from(value: char) -> Self

Converts to this type from the input type.

impl PartialEq<char> for MaybeMarkerCodepoint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for MaybeMarkerCodepoint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MaybeMarkerCodepoint

impl Eq for MaybeMarkerCodepoint

impl StructuralPartialEq for MaybeMarkerCodepoint