Enum ModeSetting 

pub enum ModeSetting {
    NotRecognized,
    Set,
    Reset,
    PermanentlySet,
    PermanentlyReset,
}

Decoded state value from a mode report response (DECRPM or ANSI report).

The numeric values are the Ps status field in ESC [ ? mode ; Ps $ y or ESC [ mode ; Ps $ y.

Variants

NotRecognized

Report value 0: the terminal does not recognize the requested mode.

Set

Report value 1: the mode is currently set.

Reset

Report value 2: the mode is currently reset.

PermanentlySet

Report value 3: the mode is permanently set and cannot be reset.

PermanentlyReset

Report value 4: the mode is permanently reset and cannot be set.

Implementations

impl ModeSetting

pub fn from_value(v: u16) -> Self

Convert a numeric mode-report status value into ModeSetting.

Values 1..=4 map to their defined states; every other value maps to ModeSetting::NotRecognized.

pub fn value(self) -> u16

Return the numeric status value used in mode-report responses.

pub fn is_set(self) -> bool

Return true for ModeSetting::Set and ModeSetting::PermanentlySet.

pub fn is_reset(self) -> bool

Return true for ModeSetting::Reset and ModeSetting::PermanentlyReset.

pub fn is_recognized(self) -> bool

Return whether the terminal recognized the mode.

Only ModeSetting::NotRecognized is considered unrecognized.

pub fn is_permanent(self) -> bool

Return whether the mode is permanently fixed and cannot be toggled.

Both ModeSetting::PermanentlySet and ModeSetting::PermanentlyReset report a state the host cannot change.

pub fn is_available(self) -> bool

Return whether the mode can actually be used by the host.

This is true for every recognized state except ModeSetting::PermanentlyReset: a permanently reset mode is recognized but the terminal will never allow it to be set, so the feature it gates is effectively unavailable. Use this (rather than is_recognized) when deciding whether a capability can be relied upon.

Trait Implementations

impl Clone for ModeSetting

fn clone(&self) -> ModeSetting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModeSetting

impl Debug for ModeSetting

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

Formats the value using the given formatter.

impl Display for ModeSetting

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

Formats the value using the given formatter.

impl Eq for ModeSetting

impl Hash for ModeSetting

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 PartialEq for ModeSetting

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