Struct DecoderFlags 

pub struct DecoderFlags(/* private fields */);

Optional disambiguation knobs for the input decoder.

With no flag set and Backarrow mode reset, the decoder reports:

• 0x00 → Ctrl+Space
• 0x08 → Ctrl+h
• 0x09 → Tab
• 0x0a → Ctrl+j
• 0x0d → Enter
• 0x7f → Backspace
• CSI 1 ~ → Home
• CSI 4 ~ → End

Set the corresponding flag to swap each mapping to its alternative reading.

In raw mode, terminals normally send LF for Ctrl+J and CR for Enter. An ESC prefix adds Alt to the selected interpretation.

Backarrow mode (DECBKM) defaults to reset. When set, 0x08 reads as Backspace and 0x7f as Ctrl+Backspace. These are legacy byte interpretations: terminals can send the same bytes for different keys.

CTRL_H overrides 0x08 in either mode and takes precedence over CTRL_BACKSPACE. DEL_IS_DELETE overrides 0x7f in either mode.

Implementations

impl DecoderFlags

pub const CTRL_AT: Self

Report 0x00 as Ctrl+@ instead of Ctrl+Space.

pub const CTRL_I: Self

Report 0x09 as Ctrl+i instead of Tab.

pub const CTRL_M: Self

Report 0x0d as Ctrl+m instead of Enter.

pub const CTRL_OPEN_BRACKET: Self

Report a lone 0x1b as Ctrl+[ instead of Escape.

Wherever that byte resolves as a key of its own: an EventSource reaching its escape deadline, whether the ESC was alone or at the head of a sequence that never finished, and the inner ESC of a run of them, which reads as Alt+Ctrl+[.

pub const DEL_IS_DELETE: Self

Report 0x7f as Delete instead of Backspace.

Takes precedence over Backarrow mode, including when 0x7f would otherwise read as Ctrl+Backspace.

pub const FIND_KEY: Self

Report CSI 1 ~ as the VT220 Find key instead of Home.

pub const SELECT_KEY: Self

Report CSI 4 ~ as the VT220 Select key instead of End.

pub const LF_IS_ENTER: Self

Report 0x0a (LF) as Enter instead of Ctrl+j.

An ESC prefix reports Alt+Enter. This is useful for input with CR-to-LF conversion enabled. CR keeps its own interpretation, selected by CTRL_M.

pub const CTRL_H: Self

Report 0x08 as Ctrl+h in either Backarrow mode.

Takes precedence over CTRL_BACKSPACE and the mode’s Backspace interpretation.

pub const CTRL_BACKSPACE: Self

Report 0x08 as Ctrl+Backspace when Backarrow mode is reset.

When the mode is set, 0x08 reads as Backspace and 0x7f already reads as Ctrl+Backspace. CTRL_H and DEL_IS_DELETE retain their precedence.

impl DecoderFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

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

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> Self

Convert from a bits value exactly.

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

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: Self) -> bool

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

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

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

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

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

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

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: Self)

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

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

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

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

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

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

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

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

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: Self) -> Self

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

pub const fn complement(self) -> Self

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

impl DecoderFlags

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

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<DecoderFlags>

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 DecoderFlags

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

Formats the value using the given formatter.

impl BitAnd for DecoderFlags

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

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

type Output = DecoderFlags

The resulting type after applying the & operator.

impl BitAndAssign for DecoderFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for DecoderFlags

fn bitor(self, other: DecoderFlags) -> Self

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

type Output = DecoderFlags

The resulting type after applying the | operator.

impl BitOrAssign for DecoderFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for DecoderFlags

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

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

type Output = DecoderFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DecoderFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for DecoderFlags

fn clone(&self) -> DecoderFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecoderFlags

impl Debug for DecoderFlags

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

Formats the value using the given formatter.

impl Default for DecoderFlags

fn default() -> DecoderFlags

Returns the “default value” for a type.

impl Eq for DecoderFlags

impl Extend<DecoderFlags> for DecoderFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

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 DecoderFlags

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

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> DecoderFlags

Convert from a bits value exactly.

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 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<DecoderFlags> for DecoderFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

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

impl Hash for DecoderFlags

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

type Item = DecoderFlags

The type of the elements being iterated over.

type IntoIter = Iter<DecoderFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for DecoderFlags

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

Formats the value using the given formatter.

impl Not for DecoderFlags

fn not(self) -> Self

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

type Output = DecoderFlags

The resulting type after applying the ! operator.

impl Octal for DecoderFlags

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

Formats the value using the given formatter.

impl PartialEq for DecoderFlags

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

Equality operator ==.

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

Inequality operator !=.

impl PublicFlags for DecoderFlags

type Primitive = u16

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl StructuralPartialEq for DecoderFlags

impl Sub for DecoderFlags

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

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 = DecoderFlags

The resulting type after applying the - operator.

impl SubAssign for DecoderFlags

fn sub_assign(&mut self, other: Self)

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 DecoderFlags

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

Formats the value using the given formatter.