Struct icu::properties::CodePointMapDataBorrowed

pub struct CodePointMapDataBorrowed<'a, T>
where
    T: TrieValue,
{ /* private fields */ }

A borrowed wrapper around code point set data, returned by CodePointSetData::as_borrowed(). More efficient to query.

Implementations

impl<'a, T> CodePointMapDataBorrowed<'a, T>

where T: TrieValue,

pub fn get(self, ch: char) -> T

Get the value this map has associated with code point ch

Example

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

let gc = CodePointMapData::<GeneralCategory>::new();

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

pub fn get32(self, ch: u32) -> T

See Self::get.

pub fn get_set_for_value(self, value: T) -> CodePointSetData

Get a CodePointSetData for all elements corresponding to a particular value

Example

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

let gc = CodePointMapData::<GeneralCategory>::new();

let other_letter_set_data =
    gc.get_set_for_value(GeneralCategory::OtherLetter);
let other_letter_set = other_letter_set_data.as_borrowed();

assert!(other_letter_set.contains('木')); // U+6728
assert!(!other_letter_set.contains('🎃')); // U+1F383 JACK-O-LANTERN

pub fn iter_ranges(self) -> impl Iterator<Item = CodePointMapRange<T>> + 'a

Yields an Iterator returning ranges of consecutive code points that share the same value in the CodePointMapData.

Examples

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

let gc = CodePointMapData::<GeneralCategory>::new();
let mut ranges = gc.iter_ranges();
let next = ranges.next().unwrap();
assert_eq!(next.range, 0..=31);
assert_eq!(next.value, GeneralCategory::Control);
let next = ranges.next().unwrap();
assert_eq!(next.range, 32..=32);
assert_eq!(next.value, GeneralCategory::SpaceSeparator);

pub fn iter_ranges_for_value( self, val: T, ) -> impl Iterator<Item = RangeInclusive<u32>> + 'a

Yields an Iterator returning ranges of consecutive code points that share the same value v in the CodePointMapData.

Examples

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

let gc = CodePointMapData::<GeneralCategory>::new();
let mut ranges = gc.iter_ranges_for_value(GeneralCategory::UppercaseLetter);
assert_eq!(ranges.next().unwrap(), 'A' as u32..='Z' as u32);
assert_eq!(ranges.next().unwrap(), 'À' as u32..='Ö' as u32);
assert_eq!(ranges.next().unwrap(), 'Ø' as u32..='Þ' as u32);

pub fn iter_ranges_for_value_complemented( self, val: T, ) -> impl Iterator<Item = RangeInclusive<u32>> + 'a

Yields an Iterator returning ranges of consecutive code points that do not have the value v in the CodePointMapData.

impl CodePointMapDataBorrowed<'_, GeneralCategory>

pub fn get_set_for_value_group( &self, value: GeneralCategoryGroup, ) -> CodePointSetData

TODO

impl<T> CodePointMapDataBorrowed<'static, T>

where T: TrieValue,

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

where T: EnumeratedProperty,

Creates a new CodePointMapDataBorrowed for a EnumeratedProperty.

See the documentation on EnumeratedProperty implementations for details.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub const fn static_to_owned(self) -> CodePointMapData<T>

Cheaply converts a [CodePointMapDataBorrowed<'static>] into a CodePointMapData.

Note: Due to branching and indirection, using CodePointMapData might inhibit some compile-time optimizations that are possible with CodePointMapDataBorrowed.

impl<'a> CodePointMapDataBorrowed<'a, GeneralCategory>

pub fn iter_ranges_for_group( self, group: GeneralCategoryGroup, ) -> impl Iterator<Item = RangeInclusive<u32>> + 'a

Yields an Iterator returning ranges of consecutive code points that have a General_Category value belonging to the specified GeneralCategoryGroup

Examples

use icu::properties::props::{GeneralCategory, GeneralCategoryGroup};
use icu::properties::CodePointMapData;

let gc = CodePointMapData::<GeneralCategory>::new();
let mut ranges = gc.iter_ranges_for_group(GeneralCategoryGroup::Letter);
assert_eq!(ranges.next().unwrap(), 'A' as u32..='Z' as u32);
assert_eq!(ranges.next().unwrap(), 'a' as u32..='z' as u32);
assert_eq!(ranges.next().unwrap(), 'ª' as u32..='ª' as u32);
assert_eq!(ranges.next().unwrap(), 'µ' as u32..='µ' as u32);
assert_eq!(ranges.next().unwrap(), 'º' as u32..='º' as u32);
assert_eq!(ranges.next().unwrap(), 'À' as u32..='Ö' as u32);
assert_eq!(ranges.next().unwrap(), 'Ø' as u32..='ö' as u32);

Trait Implementations

impl BidiDataSource for CodePointMapDataBorrowed<'_, BidiClass>

Implements [unicode_bidi::BidiDataSource] on CodePointMapDataBorrowed<BidiClass>.

✨ Enabled with the unicode_bidi Cargo feature.

Examples

 use icu::properties::CodePointMapData;
 use icu::properties::props::BidiClass;
 use unicode_bidi::BidiInfo;

 // This example text is defined using `concat!` because some browsers
 // and text editors have trouble displaying bidi strings.
 let text =  concat!["א", // RTL#1
                     "ב", // RTL#2
                     "ג", // RTL#3
                     "a", // LTR#1
                     "b", // LTR#2
                     "c", // LTR#3
                     ]; //


 let bidi_map = CodePointMapData::<BidiClass>::new();

 // Resolve embedding levels within the text.  Pass `None` to detect the
 // paragraph level automatically.
 let bidi_info = BidiInfo::new_with_data_source(&bidi_map, text, None);

 // This paragraph has embedding level 1 because its first strong character is RTL.
 assert_eq!(bidi_info.paragraphs.len(), 1);
 let para = &bidi_info.paragraphs[0];
 assert_eq!(para.level.number(), 1);
 assert!(para.level.is_rtl());

 // Re-ordering is done after wrapping each paragraph into a sequence of
 // lines. For this example, I'll just use a single line that spans the
 // entire paragraph.
 let line = para.range.clone();

 let display = bidi_info.reorder_line(para, line);
 assert_eq!(display, concat!["a", // LTR#1
                             "b", // LTR#2
                             "c", // LTR#3
                             "ג", // RTL#3
                             "ב", // RTL#2
                             "א", // RTL#1
                             ]);

fn bidi_class(&self, c: char) -> BidiClass

fn bidi_matched_opening_bracket( &self, c: char, ) -> Option<BidiMatchedOpeningBracket>

If this character is a bracket according to BidiBrackets.txt, return the corresponding normalized opening bracket of the pair, and whether or not it itself is an opening bracket.

impl<'a, T> Clone for CodePointMapDataBorrowed<'a, T>

where T: Clone + TrieValue,

fn clone(&self) -> CodePointMapDataBorrowed<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for CodePointMapDataBorrowed<'a, T>

where T: Debug + TrieValue,

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

Formats the value using the given formatter.

impl<T> Default for CodePointMapDataBorrowed<'static, T>

where T: EnumeratedProperty,

fn default() -> CodePointMapDataBorrowed<'static, T>

Returns the “default value” for a type.

impl<'a, T> Copy for CodePointMapDataBorrowed<'a, T>

where T: Copy + TrieValue,