Struct ControlFunction

pub struct ControlFunction<'a> { /* private fields */ }

An ansi control function defined in ECMA-48.

This struct implements the PartialEq trait for String-like types (all types that implement AsRef<str>). It can be used to compare ControlFunctions with string-like values using == or != functions.

Example:

use ansi_control_codes::c0;

let some_string = String::from("\u{001B}");
if (c0::ESC == some_string) {
    println!("ESC!")
}

Implementations

impl<'a> ControlFunction<'a>

pub fn private_use( value: &'a str, parameters: Vec<String>, ) -> Result<Self, InvalidControlFunction>

Creates a new control function representing a control sequence that is declared as private use.

These functions are not standardized and their function is unknown. Yet, the standard allows these functions to exist for experimental use.

If the specified value lies outside of the valid private use area, this function will return Err.

Trait Implementations

impl<'a> Debug for ControlFunction<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ControlFunction<'a>

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

Formats the value using the given formatter.

impl Explain for ControlFunction<'_>

fn short_name(&self) -> Option<&'static str>

Returns the short name (abbreviation) of this control function, e.g. CR, LF.

fn long_name(&self) -> &'static str

Returns the name of this control function, e.g. Carriage Return, Line Feed.

fn short_description(&self) -> String

Returns the short description of what this function does.

fn long_description(&self) -> String

Returns a long description of what this function does.

impl<'a> From<ControlFunction<'a>> for String

fn from(control_function: ControlFunction<'_>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<ControlFunction<'a>> for &str

fn eq(&self, other: &ControlFunction<'_>) -> 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<'a> PartialEq<ControlFunction<'a>> for String

fn eq(&self, other: &ControlFunction<'_>) -> 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<'a, T> PartialEq<T> for ControlFunction<'a>

where T: AsRef<str>,

fn eq(&self, other: &T) -> 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<'a> PartialEq for ControlFunction<'a>

fn eq(&self, other: &ControlFunction<'a>) -> 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<'a> Eq for ControlFunction<'a>

impl<'a> StructuralPartialEq for ControlFunction<'a>