Struct Identifier 

pub struct Identifier(pub UniCase<String>);

Tuple Fields

0: UniCase<String>

Implementations

impl Identifier

pub const MAX_LEN: usize = 64

Maximum length of an identifier, in bytes. The limit applies in the encoding used by the dictionary, not in UTF-8.

pub fn new(s: impl Into<UniCase<String>>) -> Result<Self, Error>

pub fn codepage_to_unicode(&mut self)

Converts this identifier to UTF-8. This is generally a no-op, because our internal encoding is UTF-8, but some identifiers are longer in UTF-8 than in their code page, which means that to satisfy the 64-byte limit this function sometimes has to remove trailing grapheme clusters.

pub fn from_encoding( s: impl Into<UniCase<String>>, encoding: &'static Encoding, ) -> Result<Identifier, Error>

pub fn check_encoding(&self, encoding: &'static Encoding) -> Result<(), Error>

Checks whether this is a valid identifier in the given encoding. An identifier that is valid in one encoding might be invalid in another because some characters are unencodable or because it is too long.

pub fn check_plausible(s: &str) -> Result<(), Error>

pub fn matches_keyword(&self, keyword: &str) -> bool

Returns true if token is a case-insensitive match for keyword.

Keywords match keyword and token are identical, or token is at least 3 characters long and those characters are identical to keyword or differ only in case.

keyword must be ASCII.

pub fn matches_keyword_n(&self, keyword: &str, n: usize) -> bool

Returns true if token is a case-insensitive match for at least the first n characters of keyword.

keyword must be ASCII.

pub fn must_be_ordinary(self) -> Result<Self, Error>

pub fn class(&self) -> Class

pub fn as_str(&self) -> &str

pub fn shortened(&self, encoding: &'static Encoding) -> Self

Returns this this identifier truncated to at most 8 bytes in encoding.

pub fn with_suffix( &self, suffix: &str, encoding: &'static Encoding, max_len: usize, ) -> Result<Self, Error>

Returns a prefix of this identifier concatenated with all of suffix, including as many grapheme clusters from the beginning of this identifier as would fit within max_len bytes if the resulting string were to be re-encoded in encoding.

max_len would ordinarily be 64, since that’s the maximum length of an identifier, but a value of 8 is appropriate for short variable names.

This function fails if adding or using suffix produces an invalid Identifier, for example if max_len is short enough that none of the identifier can be included and suffix begins with '_' or another character that may not appear at the beginning of an identifier.

Examples

Simple examples for UTF-8 encoding with max_len of 6:

identifier="abc",  suffix="xyz"     => "abcxyz"
identifier="abcd", suffix="xyz"     => "abcxyz"
identifier="abc",  suffix="uvwxyz"  => "uvwxyz"
identifier="abc",  suffix="tuvwxyz" => "tuvwxyz"

Examples for windows-1252 encoding with max_len of 6:

identifier="éèä",  suffix="xyz"    => "éèäxyz"

(each letter in the identifier is only 1 byte in windows-1252 even though they each take 2 bytes in UTF-8)

Methods from Deref<Target = UniCase<String>>

pub fn to_folded_case(&self) -> String

Returns a copy of this string where each character is mapped to its Unicode CaseFolding equivalent.

Note

Unicode Case Folding is meant for string storage and matching, not for display.

pub fn is_ascii(&self) -> bool

Return true if this instance will only perform ASCII case folding.

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Deref for Identifier

type Target = UniCase<String>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Identifier

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

Formats the value using the given formatter.

impl Eq for Identifier

impl From<&Identifier> for Class

fn from(id: &Identifier) -> Self

Converts to this type from the input type.

impl Hash for Identifier

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Identifier

fn cmp(&self, other: &Identifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Identifier

fn eq(&self, other: &Identifier) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Identifier

fn eq(&self, other: &str) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Identifier

fn partial_cmp(&self, other: &Identifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Identifier

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Identifier