Struct file_descriptors::terminal::CanonicalSettings

pub struct CanonicalSettings {
    pub convert_uppercase_to_lowercase: bool,
    pub echo_erase: bool,
    pub echo_new_line: bool,
    pub external_processing: bool,
    pub print_before_erase: bool,
    pub echo_kill_character: CanonicalEchoKillCharacter,
}

Abstracts the canonical settings of a terminal.

Fields

convert_uppercase_to_lowercase: bool

If set, the terminal is assumed to be uppercase only, and all input is converted to lowercase.

To input an uppercase character, precede it with a backslash. Similarly, an uppercase character is output by the system by being preceded by a backslash.

This option flag is obsolete today, since most, if not all, uppercase-only terminals have disappeared.

Equivalent to the XCASE flag.

echo_erase: bool

If set then the ERASE character erases the last character in the current line from the display.

This is usually done in the terminal driver by writing the three-character sequence 'backspace, space, backspace'.

If the word erase, WERASE, character is supported then this setting causes the previous word to be erased using one or more of the same three-character sequence when WERASE is received.

This occurs irrespective of whether the terminal has been set to echo its input.

Equivalent to the ECHOE flag.

echo_new_line: bool

If set then the new line, NL, character is echoed.

This occurs irrespective of whether the terminal has been set to echo its input.

Equivalent to the ECHONL flag.

external_processing: bool

If set, canonical character processing is performed external to the operating system.

This can be the case if the serial communication peripheral card can offload the host processor by doing some of the line discipline processing.

Equivalent to the EXTPROC flag.

print_before_erase: bool

If set then the ERASE character (and WERASE character, if supported) will cause all the characters being erased to be printed as they are erased.

This is often useful on a hard-copy terminal to see exactly which characters are being deleted.

Setting this flag will force echo to be on, overriding Echo::Off.

Equivalent to the ECHOPRT flag.

echo_kill_character: CanonicalEchoKillCharacter

Different choices for echoing the KILL character.

Trait Implementations

impl Eq for CanonicalSettings

impl Clone for CanonicalSettings

fn clone(&self) -> CanonicalSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CanonicalSettings

impl PartialOrd<CanonicalSettings> for CanonicalSettings

fn partial_cmp(&self, other: &CanonicalSettings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &CanonicalSettings) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &CanonicalSettings) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &CanonicalSettings) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &CanonicalSettings) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<CanonicalSettings> for CanonicalSettings

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for CanonicalSettings

fn cmp(&self, other: &CanonicalSettings) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for CanonicalSettings

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for CanonicalSettings

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

Formats the value using the given formatter.