Struct Console

pub struct Console { /* private fields */ }

Handle to a console device file, usually located at /dev/console. This structure allows managing virtual terminals.

Implementations

impl Console

pub fn open() -> Result<Console, Error>

Opens a new handle to the console device file.

Examples found in repository

examples/blank.rs (line 9)

fn main() {
    
    // Allocate a new vt
    let console = Console::open().expect("Cannot open console device");
    let original_vt = console.current_vt_number().unwrap();
    let mut vt = console.new_vt_with_minimum_number(7).unwrap();
    println!("Allocated new VT: {}", vt.number());
    
    println!("Switching in 3s...");
    sleep(Duration::from_secs(3));

    // Setup the vt then switch
    vt.clear()
        .and_then(|vt| vt.set_echo(true))
        .and_then(|vt| vt.switch())
        .unwrap();
    
    // Write something
    let n = vt.number();
    writeln!(vt, "Hello world, this is VT {}!", n).unwrap();

    // Blank
    writeln!(vt, "Blanking in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(true).unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(false).unwrap();

    // Switch back
    writeln!(vt, "Example finished. Switching back in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    console.switch_to(original_vt).unwrap();
}

pub fn current_vt_number(&self) -> Result<VtNumber>

Returns the currently active virtual terminal.

Examples found in repository

examples/blank.rs (line 10)

fn main() {
    
    // Allocate a new vt
    let console = Console::open().expect("Cannot open console device");
    let original_vt = console.current_vt_number().unwrap();
    let mut vt = console.new_vt_with_minimum_number(7).unwrap();
    println!("Allocated new VT: {}", vt.number());
    
    println!("Switching in 3s...");
    sleep(Duration::from_secs(3));

    // Setup the vt then switch
    vt.clear()
        .and_then(|vt| vt.set_echo(true))
        .and_then(|vt| vt.switch())
        .unwrap();
    
    // Write something
    let n = vt.number();
    writeln!(vt, "Hello world, this is VT {}!", n).unwrap();

    // Blank
    writeln!(vt, "Blanking in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(true).unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(false).unwrap();

    // Switch back
    writeln!(vt, "Example finished. Switching back in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    console.switch_to(original_vt).unwrap();
}

pub fn new_vt(&self) -> Result<Vt<'_>>

Allocates a new virtual terminal. To switch to the newly created terminal, use Vt::switch or Console::switch_to.

pub fn new_vt_with_minimum_number(&self, min: i32) -> Result<Vt<'_>>

Allocates a new virtual terminal with a number greater than or equal to the given number. Be careful not to exaggerate too much with the minimum threshold: usually systems have a maximum number of 16 or 64 vts.

To switch to the newly created terminal, use Vt::switch or Console::switch_to.

Examples found in repository

examples/blank.rs (line 11)

fn main() {
    
    // Allocate a new vt
    let console = Console::open().expect("Cannot open console device");
    let original_vt = console.current_vt_number().unwrap();
    let mut vt = console.new_vt_with_minimum_number(7).unwrap();
    println!("Allocated new VT: {}", vt.number());
    
    println!("Switching in 3s...");
    sleep(Duration::from_secs(3));

    // Setup the vt then switch
    vt.clear()
        .and_then(|vt| vt.set_echo(true))
        .and_then(|vt| vt.switch())
        .unwrap();
    
    // Write something
    let n = vt.number();
    writeln!(vt, "Hello world, this is VT {}!", n).unwrap();

    // Blank
    writeln!(vt, "Blanking in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(true).unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(false).unwrap();

    // Switch back
    writeln!(vt, "Example finished. Switching back in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    console.switch_to(original_vt).unwrap();
}

pub fn open_vt<N: AsVtNumber>(&self, vt_number: N) -> Result<Vt<'_>>

Opens the terminal with the given number.

pub fn switch_to<N: AsVtNumber>(&self, vt_number: N) -> Result<()>

Switches to the virtual terminal with the given number.

Examples found in repository

examples/blank.rs (line 37)

fn main() {
    
    // Allocate a new vt
    let console = Console::open().expect("Cannot open console device");
    let original_vt = console.current_vt_number().unwrap();
    let mut vt = console.new_vt_with_minimum_number(7).unwrap();
    println!("Allocated new VT: {}", vt.number());
    
    println!("Switching in 3s...");
    sleep(Duration::from_secs(3));

    // Setup the vt then switch
    vt.clear()
        .and_then(|vt| vt.set_echo(true))
        .and_then(|vt| vt.switch())
        .unwrap();
    
    // Write something
    let n = vt.number();
    writeln!(vt, "Hello world, this is VT {}!", n).unwrap();

    // Blank
    writeln!(vt, "Blanking in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(true).unwrap();
    sleep(Duration::from_secs(3));
    vt.blank(false).unwrap();

    // Switch back
    writeln!(vt, "Example finished. Switching back in 3s...").unwrap();
    sleep(Duration::from_secs(3));
    console.switch_to(original_vt).unwrap();
}

pub fn lock_switch(&self, lock: bool) -> Result<()>

Enables or disables virtual terminal switching (usually done with Ctrl + Alt + F<n>).

pub fn blank_timer(&self) -> Result<u32>

Returns the current console blank timer value. A value of 0 means that the timer is disabled. To change the blank timer, use the Vt::set_blank_timer method.