Struct ControlSequence

Source
pub struct ControlSequence { /* private fields */ }
Expand description

A control sequence is a string of bit combinations starting with the control function CONTROL SEQUENCE INTRODUCER (CSI).

Followed by one or more bit combinations representing parameters, if any, and by one or more bit combinations identifying the control function.

To “execute” a control sequence you can print it or call the method exec :


use coded_chars::control::ControlSequence;
let sequence = ControlSequence::new(&["1", "1"], "H");

print!("{}", sequence); // Prints \x1b[1;1H
// or
sequence.exec(); // Prints \x1b[1;1H

Almost every function from this crate return ControlSequences :

// This example is equivalent to the above example :
use coded_chars::cursor::set_position;

let sequence = set_position(1, 1); // Returns a ControlSequence
sequence.exec(); // Prints \x1b[1;1H

Implementations§

Source§

impl ControlSequence

Source

pub fn new(from: &[&str], end: &str) -> Self

Source

pub fn exec(&self)

Prints the current sequence in stdout directly.

Trait Implementations§

Source§

impl Clone for ControlSequence

Source§

fn clone(&self) -> ControlSequence

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Display for ControlSequence

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.