precious

Types

EnforcementError

pub type EnforcementError =
  profile.EnforcementError

Profile

</>

pub type Profile =
  profile.Profile

Values

enforce

</>

pub fn enforce(
  str: String,
  profile: profile.Profile,
) -> Result(String, profile.EnforcementError)

Enforcement entails applying all of the rules specified for a particular string class, or profile thereof, to a single input string, for the purpose of checking whether the string conforms to all of the rules and thus determining if the string can be used in a given protocol slot. (RFC 8264, Section 3)

nickname

</>

pub fn nickname() -> profile.Profile

PRECIS Representing Nicknames, RFC 8266 A nickname is a memorable, human-friendly name in a communications context or to set such a name for another entity such as a device, account, contact, or website. Such names are variously called “nicknames” (e.g., in chat room applications), “display names” (e.g., in Internet mail), or “petnames”.

opaque_string

</>

pub fn opaque_string() -> profile.Profile

PRECIS OpaqueString Profile, RFC 7613 The OpaqueString profile is designed for use with diverse character strings that are used in network and application protocols. The profile is intended to be broadly applicable for password-like secrets and other opaque strings (such as URIs or directory strings) that are not intended to be presented to users.

unicode_version

</>

pub fn unicode_version() -> String

Get the Unicode version that this library is based on.

username_case_mapped

</>

pub fn username_case_mapped() -> profile.Profile

PRECIS Representing Usernames and Passwords, RFC 8265 Lowercased.

username_case_preserved

</>

pub fn username_case_preserved() -> profile.Profile

PRECIS Representing Usernames and Passwords, RFC 8265 Not lowercase, not case-preserving, and not case-mapped.