Enum ContentPurpose

#[non_exhaustive]
#[repr(u32)]
pub enum ContentPurpose {
    Normal = 0,
    Alpha = 1,
    Digits = 2,
    Number = 3,
    Phone = 4,
    Url = 5,
    Email = 6,
    Name = 7,
    Password = 8,
    Date = 9,
    Time = 10,
    Datetime = 11,
    Terminal = 12,
}

Available on crate feature wayland and Linux only.

content purpose

The content purpose allows to specify the primary purpose of a text input.

This allows an input method to show special purpose input panels with extra characters or to disallow some characters.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Normal = 0

default input, allowing all characters

Alpha = 1

allow only alphabetic characters

Digits = 2

allow only digits

Number = 3

input a number (including decimal separator and sign)

Phone = 4

input a phone number

Url = 5

input an URL

Email = 6

input an email address

Name = 7

input a name of a person

Password = 8

input a password (combine with password or sensitive_data hint)

Date = 9

input a date

Time = 10

input a time

Datetime = 11

input a date and time

Terminal = 12

input for a terminal

Trait Implementations

impl Clone for ContentPurpose

fn clone(&self) -> ContentPurpose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentPurpose

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

Formats the value using the given formatter.

impl Hash for ContentPurpose

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

where __H: Hasher,

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 ContentPurpose

fn cmp(&self, other: &ContentPurpose) -> 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.

impl PartialEq for ContentPurpose

fn eq(&self, other: &ContentPurpose) -> 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 PartialOrd for ContentPurpose

fn partial_cmp(&self, other: &ContentPurpose) -> 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 TryFrom<u32> for ContentPurpose

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<ContentPurpose, ()>

Performs the conversion.

impl Copy for ContentPurpose

impl Eq for ContentPurpose

impl StructuralPartialEq for ContentPurpose