Struct CaseMapCloser

pub struct CaseMapCloser<CM> { /* private fields */ }

A wrapper around CaseMapper that can produce case mapping closures over a character or string. This wrapper can be constructed directly, or by wrapping a reference to an existing CaseMapper.

Most methods for this type live on CaseMapCloserBorrowed, which you can obtain via CaseMapCloser::new() or CaseMapCloser::as_borrowed().

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('ẞ'));

Implementations

impl CaseMapCloser<CaseMapper>

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), ) -> Result<Self, DataError>

A version of [Self :: new] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<P>(provider: &P) -> Result<Self, DataError>

where P: DataProvider<CaseMapV1> + DataProvider<CaseMapUnfoldV1> + ?Sized,

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.

impl CaseMapCloser<CaseMapper>

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

impl<CM: AsRef<CaseMapper>> CaseMapCloser<CM>

pub fn try_new_with_mapper_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), casemapper: CM, ) -> Result<Self, DataError>

A version of [Self :: new_with_mapper] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub const fn new_with_mapper(casemapper: CM) -> Self

A constructor which creates a CaseMapCloser from an existing CaseMapper (either owned or as a reference)

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_mapper_unstable<P>( provider: &P, casemapper: CM, ) -> Result<Self, DataError>

where P: DataProvider<CaseMapV1> + DataProvider<CaseMapUnfoldV1> + ?Sized,

Construct this object to wrap an existing CaseMapper (or a reference to one), loading additional data as needed. A version of Self::new_with_mapper 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) -> CaseMapCloserBorrowed<'_>

Constructs a borrowed version of this type for more efficient querying.

Trait Implementations

impl<CM: Clone> Clone for CaseMapCloser<CM>

fn clone(&self) -> CaseMapCloser<CM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CM: Debug> Debug for CaseMapCloser<CM>

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

Formats the value using the given formatter.