Struct EventBuffer

pub struct EventBuffer(pub Vec<Event>);

The event buffer is a simple wrapper around a Vec<simulate::Event>.

Tuple Fields

0: Vec<Event>

Implementations

impl EventBuffer

pub fn new() -> Self

Creates a new empty EventBuffer. (see Vec::new)

pub fn with_capacity(cap: usize) -> Self

Creates a new EventBuffer with the given capacity. (see Vec::with_capacity)

pub fn add_event(&mut self, event: Event)

Pushes a new event into the buffer. (see Vec::push)

pub fn extend(&mut self, events: impl IntoIterator<Item = Event>)

Inserts multiple events into the buffer. (see Vec::extend)

pub fn extend_from_slice(&mut self, events: &[Event])

Extends the buffer from a slice of events. (see Vec::extend_from_slice)

pub fn append(&mut self, events: &mut EventBuffer)

Appends the elements of another buffer to this one, living the other one empty. (see Vec::append)

pub fn add_multiple<K: Keylike>(&mut self, keys: impl IntoIterator<Item = K>)

Adds Press and Release events for multiple keylikes into the buffer.

pub fn send(&mut self, key: impl Keylike)

Adds a Press and a Release event for the given keylike.

pub fn press(&mut self, key: impl Keylike)

Adds a Press event for the given keylike.

pub fn release(&mut self, key: impl Keylike)

Adds a Release event for the given keylike.

pub fn type_str(&mut self, s: &str)

Adds Press and Release events for each character of the string.

pub fn move_mouse_relative(&mut self, dx: i32, dy: i32)

Adds an event that causes the mouse to move dx pixels to the right and dy pixels down.

pub fn move_mouse_absolute(&mut self, x: f32, y: f32)

Adds an event that causes the mouse to move, coordinates are normalized to the desktop: (0, 0) map to the top-left of the main monitor and (1, 1) maps to the bottom-right of the main monitor.

pub fn add_scroll_event(&mut self, delta: f32, direction: ScrollDirection)

Adds a scroll event to the buffer.

pub fn scroll(&mut self, delta: f32)

Uses the mouse wheel vertically.

pub fn scroll_horizontal(&mut self, delta: f32)

Uses the mouse wheel horizontally.

pub fn simulate(self) -> Result<()>

Simulates the events using the default simulator.

Trait Implementations

impl AsMut<Vec<Event>> for EventBuffer

fn as_mut(&mut self) -> &mut Vec<Event>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Vec<Event>> for EventBuffer

fn as_ref(&self) -> &Vec<Event>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EventBuffer

fn clone(&self) -> EventBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for EventBuffer

fn default() -> EventBuffer

Returns the “default value” for a type.

impl From<EventBuffer> for Vec<Event>

fn from(b: EventBuffer) -> Self

Converts to this type from the input type.

impl From<Vec<Event>> for EventBuffer

fn from(v: Vec<Event>) -> Self

Converts to this type from the input type.

impl IntoIterator for EventBuffer

type Item = Event

The type of the elements being iterated over.

type IntoIter = IntoIter<Event>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.