Struct ImeHint 

#[non_exhaustive]
pub struct ImeHint(/* private fields */);

IME hints

The hint should reflect the desired behaviour of the IME while entering text. The purpose may improve UX by optimizing the IME for the specific use case, beyond just the general data type specified in ImePurpose.

Platform-specific

• iOS / Android / Web / Windows / X11 / macOS / Orbital: Unsupported.

Implementations

impl ImeHint

pub const NONE: ImeHint

No special behaviour.

pub const COMPLETION: ImeHint

Suggest word completions.

pub const SPELLCHECK: ImeHint

Suggest word corrections.

pub const AUTO_CAPITALIZATION: ImeHint

Switch to uppercase letters at the start of a sentence.

pub const LOWERCASE: ImeHint

Prefer lowercase letters.

pub const UPPERCASE: ImeHint

Prefer uppercase letters.

pub const TITLECASE: ImeHint

Prefer casing for titles and headings (can be language dependent).

pub const HIDDEN_TEXT: ImeHint

Characters should be hidden.

This may prevent e.g. layout switching with some IMEs, unless hint is disabled.

pub const SENSITIVE_DATA: ImeHint

Typed text should not be stored.

pub const LATIN: ImeHint

Just Latin characters should be entered.

pub const MULTILINE: ImeHint

The text input is multiline.

impl ImeHint

pub const fn empty() -> ImeHint

Get a flags value with all bits unset.

pub const fn all() -> ImeHint

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<ImeHint>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> ImeHint

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> ImeHint

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ImeHint>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: ImeHint) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: ImeHint) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: ImeHint)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: ImeHint)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: ImeHint)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: ImeHint, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ImeHint) -> ImeHint

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: ImeHint) -> ImeHint

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: ImeHint) -> ImeHint

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: ImeHint) -> ImeHint

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> ImeHint

The bitwise negation (!) of the bits in self, truncating the result.

impl ImeHint

pub const fn iter(&self) -> Iter<ImeHint>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ImeHint>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ImeHint

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

Formats the value using the given formatter.

impl BitAnd for ImeHint

fn bitand(self, other: ImeHint) -> ImeHint

The bitwise and (&) of the bits in self and other.

type Output = ImeHint

The resulting type after applying the & operator.

impl BitAndAssign for ImeHint

fn bitand_assign(&mut self, other: ImeHint)

The bitwise and (&) of the bits in self and other.

impl BitOr for ImeHint

fn bitor(self, other: ImeHint) -> ImeHint

The bitwise or (|) of the bits in self and other.

type Output = ImeHint

The resulting type after applying the | operator.

impl BitOrAssign for ImeHint

fn bitor_assign(&mut self, other: ImeHint)

The bitwise or (|) of the bits in self and other.

impl BitXor for ImeHint

fn bitxor(self, other: ImeHint) -> ImeHint

The bitwise exclusive-or (^) of the bits in self and other.

type Output = ImeHint

The resulting type after applying the ^ operator.

impl BitXorAssign for ImeHint

fn bitxor_assign(&mut self, other: ImeHint)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for ImeHint

fn clone(&self) -> ImeHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImeHint

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

Formats the value using the given formatter.

impl Default for ImeHint

fn default() -> ImeHint

Returns the “default value” for a type.

impl Extend<ImeHint> for ImeHint

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ImeHint>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ImeHint

const FLAGS: &'static [Flag<ImeHint>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ImeHint

Convert from a bits value exactly.

fn all_named() -> ImeHint

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<ImeHint> for ImeHint

fn from_iter<T>(iterator: T) -> ImeHint

where T: IntoIterator<Item = ImeHint>,

The bitwise or (|) of the bits in each flags value.

impl Hash for ImeHint

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 IntoIterator for ImeHint

type Item = ImeHint

The type of the elements being iterated over.

type IntoIter = Iter<ImeHint>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ImeHint as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for ImeHint

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

Formats the value using the given formatter.

impl Not for ImeHint

fn not(self) -> ImeHint

The bitwise negation (!) of the bits in self, truncating the result.

type Output = ImeHint

The resulting type after applying the ! operator.

impl Octal for ImeHint

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

Formats the value using the given formatter.

impl PartialEq for ImeHint

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

fn sub(self, other: ImeHint) -> ImeHint

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ImeHint

The resulting type after applying the - operator.

impl SubAssign for ImeHint

fn sub_assign(&mut self, other: ImeHint)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ImeHint

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

Formats the value using the given formatter.

impl Copy for ImeHint

impl Eq for ImeHint

impl StructuralPartialEq for ImeHint