Struct CaseMapV1

pub struct CaseMapV1<'data> {
    pub trie: CodePointTrie<'data, CaseMapData>,
    pub exceptions: CaseMapExceptions<'data>,
}

This type contains all of the casemapping data

The methods in the provider module are primarily about accessing its data, however the full algorithms are also implemented as methods on this type in the internals module of this crate.

🚧 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.

CaseMapper provides low-level access to the data necessary to convert characters and strings to upper, lower, or title case.

Fields

trie: CodePointTrie<'data, CaseMapData>

Case mapping data

exceptions: CaseMapExceptions<'data>

Exceptions to the case mapping data

Implementations

impl<'data> CaseMapV1<'data>

pub(crate) fn lookup_data(&self, c: char) -> CaseMapData

impl<'data> CaseMapV1<'data>

const I_DOT: &'static str = "\u{69}\u{307}"

const J_DOT: &'static str = "\u{6a}\u{307}"

const I_OGONEK_DOT: &'static str = "\u{12f}\u{307}"

const I_DOT_GRAVE: &'static str = "\u{69}\u{307}\u{300}"

const I_DOT_ACUTE: &'static str = "\u{69}\u{307}\u{301}"

const I_DOT_TILDE: &'static str = "\u{69}\u{307}\u{303}"

fn simple_helper(&self, c: char, kind: MappingKind) -> char

pub(crate) fn simple_lower(&self, c: char) -> char

pub(crate) fn simple_upper(&self, c: char) -> char

pub(crate) fn simple_title(&self, c: char) -> char

pub(crate) fn simple_fold(&self, c: char, options: FoldOptions) -> char

fn dot_type(&self, c: char) -> DotType

fn is_case_sensitive(&self, c: char) -> bool

pub(crate) fn is_cased(&self, c: char) -> bool

Returns whether the character is cased

fn full_helper<const IS_TITLE_CONTEXT: bool, W: Write + ?Sized>( &self, c: char, context: ContextIterator<'_>, locale: CaseMapLocale, kind: MappingKind, sink: &mut W, ) -> Result

fn simple_fold_special_case(&self, c: char, options: FoldOptions) -> char

fn full_lower_special_case<const IS_TITLE_CONTEXT: bool>( &self, c: char, context: ContextIterator<'_>, locale: CaseMapLocale, ) -> Option<FullMappingResult<'_>>

fn full_upper_or_title_special_case<const IS_TITLE_CONTEXT: bool>( &self, c: char, context: ContextIterator<'_>, locale: CaseMapLocale, ) -> Option<FullMappingResult<'_>>

fn full_fold_special_case( &self, c: char, _context: ContextIterator<'_>, locale: CaseMapLocale, ) -> Option<FullMappingResult<'_>>

pub(crate) fn full_helper_writeable<'a: 'data, const IS_TITLE_CONTEXT: bool>( &'a self, src: &'a str, locale: CaseMapLocale, mapping: MappingKind, titlecase_tail_casing: TrailingCase, ) -> FullCaseWriteable<'a, IS_TITLE_CONTEXT>

IS_TITLE_CONTEXT is true iff the mapping is MappingKind::Title, primarily exists to avoid perf impacts on other more common modes of operation

titlecase_tail_casing is only read in IS_TITLE_CONTEXT

pub(crate) 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. 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

pub(crate) fn add_string_case_closure_to<S: ClosureSink>( &self, s: &str, set: &mut S, unfold_data: &CaseMapUnfoldV1<'_>, ) -> bool

Maps the string to single code points and adds the associated case closure mappings.

(see docs on CaseMapper::add_string_case_closure_to)

Trait Implementations

impl<'data> Clone for CaseMapV1<'data>

fn clone(&self) -> CaseMapV1<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for CaseMapV1<'data>

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

Formats the value using the given formatter.

impl<'data> PartialEq for CaseMapV1<'data>

fn eq(&self, other: &CaseMapV1<'data>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Yokeable<'a> for CaseMapV1<'static>

type Output = CaseMapV1<'a>

This type MUST be Self with the 'static replaced with 'a, i.e. Self<'a>

fn transform(&'a self) -> &'a Self::Output

This method must cast self between &'a Self<'static> and &'a Self<'a>.

fn transform_owned(self) -> Self::Output

This method must cast self between Self<'static> and Self<'a>.

unsafe fn make(this: Self::Output) -> Self

This method can be used to cast away Self<'a>’s lifetime.

fn transform_mut<F>(&'a mut self, f: F)

where F: 'static + for<'b> FnOnce(&'b mut Self::Output),

This method must cast self between &'a mut Self<'static> and &'a mut Self<'a>, and pass it to f.

impl<'zf, 'zf_inner> ZeroFrom<'zf, CaseMapV1<'zf_inner>> for CaseMapV1<'zf>

fn zero_from(this: &'zf CaseMapV1<'zf_inner>) -> Self

Clone the other C into a struct that may retain references into C.

impl<'data> StructuralPartialEq for CaseMapV1<'data>