Struct Noct 

pub struct Noct { /* private fields */ }

The main struct for handling the event emitting

Implementations

impl Noct

pub fn delay(&self) -> u64

Get the delay per keypress. Default value is 12000. This is Linux-specific.

pub fn set_delay(&mut self, delay: u64)

Set the delay per keypress. This is Linux-specific.

impl Noct

pub fn new() -> Self

Constructs a new Noct instance.

Example

use noct::*;
let mut noct = Noct::new();

Examples found in repository

examples/key.rs (line 7)

fn main() {
    thread::sleep(Duration::from_secs(2));
    let mut noct = Noct::new();

    noct.key_down(Key::Layout('a'));
    thread::sleep(Duration::from_secs(1));
    noct.key_up(Key::Layout('a'));
}

examples/dsl.rs (line 7)

fn main() {
    thread::sleep(Duration::from_secs(2));
    let mut noct = Noct::new();

    // write text and select all
    noct.key_sequence_parse("{+UNICODE}{{Hello World!}} ❤️{-UNICODE}{+CTRL}a{-CTRL}");
}

examples/keyboard.rs (line 7)

fn main() {
    thread::sleep(Duration::from_secs(2));
    let mut noct = Noct::new();

    // write text
    noct.key_sequence("Hello World! here is a lot of text  ❤️");

    // select all
    noct.key_down(Key::Control);
    noct.key_click(Key::Layout('a'));
    noct.key_up(Key::Control);
}

examples/timer.rs (line 8)

fn main() {
    thread::sleep(Duration::from_secs(2));
    let mut noct = Noct::new();

    let now = Instant::now();

    // write text
    noct.key_sequence("Hello World! ❤️");

    let time = now.elapsed();
    println!("{:?}", time);

    // select all
    noct.key_down(Key::Control);
    noct.key_click(Key::Layout('a'));
    noct.key_up(Key::Control);
}

examples/mouse.rs (line 7)

fn main() {
    let wait_time = Duration::from_secs(2);
    let mut noct = Noct::new();

    thread::sleep(wait_time);

    noct.mouse_move_to(500, 200);
    thread::sleep(wait_time);

    noct.mouse_down(MouseButton::Left);
    thread::sleep(wait_time);

    noct.mouse_move_relative(100, 100);
    thread::sleep(wait_time);

    noct.mouse_up(MouseButton::Left);
    thread::sleep(wait_time);

    noct.mouse_click(MouseButton::Left);
    thread::sleep(wait_time);

    noct.mouse_scroll_x(2);
    thread::sleep(wait_time);

    noct.mouse_scroll_x(-2);
    thread::sleep(wait_time);

    noct.mouse_scroll_y(2);
    thread::sleep(wait_time);

    noct.mouse_scroll_y(-2);
    thread::sleep(wait_time);
}

Trait Implementations

impl Debug for Noct

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

Formats the value using the given formatter.

impl Default for Noct

fn default() -> Self

Create a new Noct instance

impl Drop for Noct

fn drop(&mut self)

Executes the destructor for this type.

impl KeyboardControllable for Noct

fn key_sequence(&mut self, sequence: &str)

Types the string

fn key_down(&mut self, key: Key)

presses a given key down

fn key_up(&mut self, key: Key)

release a given key formally pressed down by key_down

fn key_click(&mut self, key: Key)

Much like the key_down and key_up function they’re just invoked consecutively

fn key_sequence_parse(&mut self, sequence: &str)

where Self: Sized,

Types the string parsed with DSL.

fn key_sequence_parse_try(&mut self, sequence: &str) -> Result<(), ParseError>

where Self: Sized,

Same as key_sequence_parse except returns any errors

impl MouseControllable for Noct

fn mouse_move_to(&mut self, x: i32, y: i32)

Lets the mouse cursor move to the specified x and y coordinates.

fn mouse_move_relative(&mut self, x: i32, y: i32)

Lets the mouse cursor move the specified amount in the x and y direction.

fn mouse_down(&mut self, button: MouseButton)

Push down one of the mouse buttons

fn mouse_up(&mut self, button: MouseButton)

Lift up a pushed down mouse button

fn mouse_click(&mut self, button: MouseButton)

Click a mouse button

fn mouse_scroll_x(&mut self, length: i32)

Scroll the mouse (wheel) left or right

fn mouse_scroll_y(&mut self, length: i32)

Scroll the mouse (wheel) up or down

impl Send for Noct