Struct icu_properties::provider::names::NormalizedPropertyNameStr

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

This is a property name that can be “loose matched” as according to PropertyValueAliases.txt

(matched case-insensitively in ASCII, ignoring underscores, whitespace, and hyphens)

This is expected to be ASCII, but we do not rely on this invariant anywhere except during datagen.

The Ord impl will sort things using strict equality, but in such a way that all loose-equal items will sort into the same area, such that a map can be searched for both strict and loose equality.

🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. While the serde representation of data structs is guaranteed to be stable, their Rust representation might not be. Use with caution.

Examples

Using a NormalizedPropertyNameStr as the key of a ZeroMap:

use icu::properties::provider::names::NormalizedPropertyNameStr;
use zerovec::ZeroMap;

let map: ZeroMap<NormalizedPropertyNameStr, usize> = [
    (NormalizedPropertyNameStr::from_str("A_BC"), 11),
    (NormalizedPropertyNameStr::from_str("dEf"), 22),
    (NormalizedPropertyNameStr::from_str("G_H-I"), 33),
]
.into_iter()
.collect();

let key_approx = NormalizedPropertyNameStr::from_str("AB-C");
let key_exact = NormalizedPropertyNameStr::from_str("A_BC");

// Strict lookup:
assert_eq!(None, map.get_copied(key_approx));
assert_eq!(Some(11), map.get_copied(key_exact));

// Loose lookup:
assert_eq!(Some(11), map.get_copied_by(|u| u.cmp_loose(key_approx)));
assert_eq!(Some(11), map.get_copied_by(|u| u.cmp_loose(key_exact)));

Implementations

impl NormalizedPropertyNameStr

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

Perform the loose comparison as defined in NormalizedPropertyNameStr.

pub const fn from_str(s: &str) -> &Self

Convert a string reference to a NormalizedPropertyNameStr.

pub const fn cast_ref(value: &UnvalidatedStr) -> &Self

Convert a UnvalidatedStr reference to a NormalizedPropertyNameStr reference.

pub const fn cast_box(value: Box<UnvalidatedStr>) -> Box<Self>

Convert a UnvalidatedStr box to a NormalizedPropertyNameStr box.

pub fn boxed_from_bytes(b: &[u8]) -> Box<Self>

Get a NormalizedPropertyNameStr box from a byte slice.

Trait Implementations

impl Debug for NormalizedPropertyNameStr

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for &'a NormalizedPropertyNameStr

where 'de: 'a,

This impl requires enabling the optional serde Cargo feature of the icu::properties crate

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<NormalizedPropertyNameStr>

This impl requires enabling the optional serde Cargo feature of the icu::properties crate

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for NormalizedPropertyNameStr

The Ord impl will sort things using strict equality, but in such a way that all loose-equal items will sort into the same area, such that a map can be searched for both strict and loose equality.

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

This method returns an Ordering between self and other.

impl PartialEq for NormalizedPropertyNameStr

fn eq(&self, other: &NormalizedPropertyNameStr) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NormalizedPropertyNameStr

The Ord/PartialOrd impl will sort things using strict equality, but in such a way that all loose-equal items will sort into the same area, such that a map can be searched for both strict and loose equality.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for NormalizedPropertyNameStr

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VarULE for NormalizedPropertyNameStr

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

Validates a byte slice, &[u8].

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 parse_byte_slice(bytes: &[u8]) -> Result<&Self, ZeroVecError>

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

fn as_byte_slice(&self) -> &[u8]

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

fn to_boxed(&self) -> Box<Self>

Allocate on the heap as a Box<T>

impl<'a> ZeroMapKV<'a> for NormalizedPropertyNameStr

type Container = VarZeroVec<'a, NormalizedPropertyNameStr>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = VarZeroSlice<NormalizedPropertyNameStr>

type GetType = NormalizedPropertyNameStr

The type produced by Container::get()

type OwnedType = Box<NormalizedPropertyNameStr>

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl Eq for NormalizedPropertyNameStr

impl StructuralPartialEq for NormalizedPropertyNameStr