Struct zerovec::ule::CharULE

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

A u8 array of little-endian data corresponding to a Unicode scalar value.

The bytes of a CharULE are guaranteed to represent a little-endian-encoded u32 that is a valid char and can be converted without validation.

Examples

Convert a char to a CharULE and back again:

use zerovec::ule::{AsULE, CharULE, ULE};

let c1 = '𑄃';
let ule = c1.to_unaligned();
assert_eq!(CharULE::as_byte_slice(&[ule]), &[0x03, 0x11, 0x01]);
let c2 = char::from_unaligned(ule);
assert_eq!(c1, c2);

Attempt to parse invalid bytes to a CharULE:

use zerovec::ule::{CharULE, ULE};

let bytes: &[u8] = &[0xFF, 0xFF, 0xFF, 0xFF];
CharULE::parse_byte_slice(bytes).expect_err("Invalid bytes");

Implementations

impl CharULE

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

Converts a char to a CharULE. This is equivalent to calling AsULE::to_unaligned()

See the type-level documentation for CharULE for more information.

pub fn to_char(self) -> char

Converts this CharULE to a char. This is equivalent to calling AsULE::from_unaligned

See the type-level documentation for CharULE for more information.

pub const fn from_array<const N: usize>(arr: [char; N]) -> [Self; N]

Convert an array of char to an array of CharULE.

Trait Implementations

impl Clone for CharULE

fn clone(&self) -> CharULE

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CharULE

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

Formats the value using the given formatter.

impl Hash for CharULE

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 CharULE

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CharULE

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

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 ULE for CharULE

fn validate_byte_slice(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

fn parse_byte_slice(bytes: &[u8]) -> Result<&[Self], UleError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success.

fn as_byte_slice(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.

impl Copy for CharULE

impl Eq for CharULE

impl StructuralPartialEq for CharULE