Struct CaseMapCloserBorrowed

pub struct CaseMapCloserBorrowed<'a> { /* private fields */ }

A borrowed CaseMapCloser.

See methods or CaseMapCloser for examples.

Implementations

impl CaseMapCloserBorrowed<'static>

pub const fn new() -> CaseMapCloserBorrowed<'static>

A constructor which creates a CaseMapCloserBorrowed using compiled data.

Examples

use icu::casemap::CaseMapCloser;
use icu::collections::codepointinvlist::CodePointInversionListBuilder;

let cm = CaseMapCloser::new();
let mut builder = CodePointInversionListBuilder::new();
let found = cm.add_string_case_closure_to("ffi", &mut builder);
assert!(found);
let set = builder.build();

assert!(set.contains('ffi'));

let mut builder = CodePointInversionListBuilder::new();
let found = cm.add_string_case_closure_to("ss", &mut builder);
assert!(found);
let set = builder.build();

assert!(set.contains('ß'));
assert!(set.contains('ẞ'));

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub const fn static_to_owned(self) -> CaseMapCloser<CaseMapper>

Cheaply converts a [CaseMapCloserBorrowed<'static>] into a CaseMapCloser.

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

impl CaseMapCloserBorrowed<'_>

pub fn add_case_closure_to<S: ClosureSink>(self, c: char, set: &mut S)

Adds all simple case mappings and the full case folding for c to set. Also adds special case closure mappings.

In other words, this adds all strings/characters that this casemaps to, as well as all characters that may casemap to this one.

The character itself is not added.

For example, the mappings

• for s include long s
• for sharp s include ss
• for k include the Kelvin sign

This function is identical to CaseMapperBorrowed::add_case_closure_to(); if you don’t need Self::add_string_case_closure_to() consider using a CaseMapper to avoid loading additional data.

Examples

use icu::casemap::CaseMapCloser;
use icu::collections::codepointinvlist::CodePointInversionListBuilder;

let cm = CaseMapCloser::new();
let mut builder = CodePointInversionListBuilder::new();
cm.add_case_closure_to('s', &mut builder);

let set = builder.build();

assert!(set.contains('S'));
assert!(set.contains('ſ'));
assert!(!set.contains('s')); // does not contain itself

pub fn add_string_case_closure_to<S: ClosureSink>( self, s: &str, set: &mut S, ) -> bool

Finds all characters and strings which may casemap to s as their full case folding string and adds them to the set. Includes the full case closure of each character mapping.

In other words, this performs a reverse full case folding and then adds the case closure items of the resulting code points.

The string itself is not added to the set.

Returns true if the string was found

Examples

use icu::casemap::CaseMapCloser;
use icu::collections::codepointinvlist::CodePointInversionListBuilder;

let cm = CaseMapCloser::new();
let mut builder = CodePointInversionListBuilder::new();
let found = cm.add_string_case_closure_to("ffi", &mut builder);
assert!(found);
let set = builder.build();

assert!(set.contains('ffi'));

let mut builder = CodePointInversionListBuilder::new();
let found = cm.add_string_case_closure_to("ss", &mut builder);
assert!(found);
let set = builder.build();

assert!(set.contains('ß'));
assert!(set.contains('ẞ'));

Trait Implementations

impl<'a> Clone for CaseMapCloserBorrowed<'a>

fn clone(&self) -> CaseMapCloserBorrowed<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CaseMapCloserBorrowed<'a>

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

Formats the value using the given formatter.

impl Default for CaseMapCloserBorrowed<'static>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for CaseMapCloserBorrowed<'a>