Struct PotentialCodePoint

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

A 24-bit numeric data type that is expected to be a Unicode scalar value, but is not validated as such.

Use this type instead of char when you want to deal with data that is expected to be valid Unicode scalar values, but you want control over when or if you validate that assumption.

Examples

use potential_utf::PotentialCodePoint;

assert_eq!(PotentialCodePoint::from_u24(0x68).try_to_char(), Ok('h'));
assert_eq!(PotentialCodePoint::from_char('i').try_to_char(), Ok('i'));
assert_eq!(
    PotentialCodePoint::from_u24(0x1F44B).try_to_char(),
    Ok('👋')
);

assert!(PotentialCodePoint::from_u24(0xDE01).try_to_char().is_err());
assert_eq!(
    PotentialCodePoint::from_u24(0xDE01).to_char_lossy(),
    char::REPLACEMENT_CHARACTER
);

Implementations

impl PotentialCodePoint

pub const fn from_char(c: char) -> Self

Create a PotentialCodePoint from a char.

Examples

use potential_utf::PotentialCodePoint;

let a = PotentialCodePoint::from_char('a');
assert_eq!(a.try_to_char().unwrap(), 'a');

pub const fn from_u24(c: u32) -> Self

Create PotentialCodePoint from a u32 value, ignoring the most significant 8 bits.

pub fn try_to_char(self) -> Result<char, CharTryFromError>

Attempt to convert a PotentialCodePoint to a char.

Examples

use potential_utf::PotentialCodePoint;
use zerovec::ule::AsULE;

let a = PotentialCodePoint::from_char('a');
assert_eq!(a.try_to_char(), Ok('a'));

let b = PotentialCodePoint::from_unaligned([0xFF, 0xFF, 0xFF].into());
assert!(matches!(b.try_to_char(), Err(_)));

pub fn to_char_lossy(self) -> char

Convert a PotentialCodePoint to a char', returning [char::REPLACEMENT_CHARACTER] if the PotentialCodePoint` does not represent a valid Unicode scalar value.

Examples

use potential_utf::PotentialCodePoint;
use zerovec::ule::AsULE;

let a = PotentialCodePoint::from_unaligned([0xFF, 0xFF, 0xFF].into());
assert_eq!(a.to_char_lossy(), char::REPLACEMENT_CHARACTER);

pub unsafe fn to_char_unchecked(self) -> char

Convert a PotentialCodePoint to a char without checking that it is a valid Unicode scalar value.

Safety

The PotentialCodePoint must be a valid Unicode scalar value in little-endian order.

Examples

use potential_utf::PotentialCodePoint;

let a = PotentialCodePoint::from_char('a');
assert_eq!(unsafe { a.to_char_unchecked() }, 'a');

pub const fn to_unaligned(self) -> RawBytesULE<3>

For converting to the ULE type in a const context

Can be removed once const traits are a thing

Trait Implementations

impl AsULE for PotentialCodePoint

This impl requires enabling the optional zerovec Cargo feature

type ULE = RawBytesULE<3>

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self.

impl Clone for PotentialCodePoint

fn clone(&self) -> PotentialCodePoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PotentialCodePoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PotentialCodePoint

This impl requires enabling the optional serde Cargo feature

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PotentialCodePoint> for u32

fn from(x: PotentialCodePoint) -> Self

Converts to this type from the input type.

impl From<char> for PotentialCodePoint

fn from(value: char) -> Self

Converts to this type from the input type.

impl Hash for PotentialCodePoint

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PotentialCodePoint

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<PotentialCodePoint> for char

fn eq(&self, other: &PotentialCodePoint) -> 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<char> for PotentialCodePoint

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 PotentialCodePoint

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

fn partial_cmp(&self, other: &PotentialCodePoint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<char> for PotentialCodePoint

fn partial_cmp(&self, other: &char) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for PotentialCodePoint

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PotentialCodePoint

This impl requires enabling the optional serde Cargo feature

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PotentialCodePoint> for char

type Error = CharTryFromError

The type returned in the event of a conversion error.

fn try_from(value: PotentialCodePoint) -> Result<char, Self::Error>

Performs the conversion.

impl TryFrom<u32> for PotentialCodePoint

type Error = ()

The type returned in the event of a conversion error.

fn try_from(x: u32) -> Result<Self, ()>

Performs the conversion.

impl Copy for PotentialCodePoint

impl Eq for PotentialCodePoint

impl EqULE for PotentialCodePoint

This impl requires enabling the optional zerovec Cargo feature

impl StructuralPartialEq for PotentialCodePoint