Struct icu_properties::CodePointMapData

pub struct CodePointMapData<T: TrieValue> { /* private fields */ }

A wrapper around code point map data.

It is returned by APIs that return Unicode property data in a map-like form, ex: enumerated property value data keyed by code point. Access its data via the borrowed version, CodePointMapDataBorrowed.

Implementations

impl<T: TrieValue> CodePointMapData<T>

pub const fn new() -> CodePointMapDataBorrowed<'static, T>

where T: EnumeratedProperty,

Creates a new CodePointMapData for a EnumeratedProperty.

See the documentation on EnumeratedProperty implementations for details.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_unstable( provider: &(impl DataProvider<T::DataMarker> + ?Sized), ) -> Result<Self, DataError>

where T: EnumeratedProperty,

A version of Self::new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn as_borrowed(&self) -> CodePointMapDataBorrowed<'_, T>

Construct a borrowed version of this type that can be queried.

This avoids a potential small underlying cost per API call (like get()) by consolidating it up front.

This owned version if returned by functions that use a runtime data provider.

pub fn try_into_converted<P>(self) -> Result<CodePointMapData<P>, UleError>

where P: TrieValue,

Convert this map to a map around another type

Typically useful for type-erasing maps into maps around integers.

Panics

Will panic if T and P are different sizes

Example

use icu::properties::CodePointMapData;
use icu::properties::props::GeneralCategory;

let data = CodePointMapData::<GeneralCategory>::new().static_to_owned();

let gc = data.try_into_converted::<u8>().unwrap();
let gc = gc.as_borrowed();

assert_eq!(gc.get('木'), GeneralCategory::OtherLetter as u8);  // U+6728
assert_eq!(gc.get('🎃'), GeneralCategory::OtherSymbol as u8);  // U+1F383 JACK-O-LANTERN

pub fn from_code_point_trie(trie: CodePointTrie<'static, T>) -> Self

Construct a new one an owned [CodePointTrie]

pub fn as_code_point_trie(&self) -> Option<&CodePointTrie<'_, T>>

Convert this type to a [CodePointTrie] as a borrowed value.

The data backing this is extensible and supports multiple implementations. Currently it is always [CodePointTrie]; however in the future more backends may be added, and users may select which at data generation time.

This method returns an Option in order to return None when the backing data provider cannot return a [CodePointTrie], or cannot do so within the expected constant time constraint.

pub fn to_code_point_trie(&self) -> CodePointTrie<'_, T>

Convert this type to a [CodePointTrie], borrowing if possible, otherwise allocating a new [CodePointTrie].

The data backing this is extensible and supports multiple implementations. Currently it is always [CodePointTrie]; however in the future more backends may be added, and users may select which at data generation time.

The performance of the conversion to this specific return type will vary depending on the data structure that is backing self.

Trait Implementations

impl<T: Clone + TrieValue> Clone for CodePointMapData<T>

fn clone(&self) -> CodePointMapData<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + TrieValue> Debug for CodePointMapData<T>

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

Formats the value using the given formatter.