Struct input::Libinput

pub struct Libinput { /* fields omitted */ }

Libinput context

Contexts can be used to track input devices and receive events from them. You can use either new_from_udev to create a context tracking all devices on a specific seat, or use new_from_path to track input devices manually.

Either way you then have to use dispatch() and next() (provided by the Iterator trait) to receive events.

Methods

impl Libinput

unsafe fn new_from_udev<T: 'static>(
    interface: LibinputInterface,
    userdata: Option<T>,
    udev_context: *mut c_void
) -> Libinput

Create a new libinput context using a udev context.

This context is inactive until udev_assign_seat is called.

Arguments

• interface - A LibinputInterface providing functions to open and close devices.
• userdata - Optionally some userdata attached to the newly created context (see Userdata)
• udev_context - Raw pointer to a valid udev context.

Unsafety

This function is unsafe, because there is no way to verify that udev_context is indeed a valid udev context or even points to valid memory.

fn new_from_path<T: 'static>(
    interface: LibinputInterface,
    userdata: Option<T>
) -> Libinput

Create a new libinput context that requires the caller to manually add or remove devices.

The returned context is active, but will not yield any events until at least one device is added.

Devices can be added and removed by calling path_add_device and path_remove_device respectively.

Arguments

• interface - A LibinputInterface providing functions to open and close devices.
• userdata - Optionally some userdata attached to the newly created context (see Userdata)

fn path_add_device(&mut self, path: &str) -> Option<Device>

Add a device to a libinput context initialized with new_from_context.

If successful, the device will be added to the internal list and re-opened on resume. The device can be removed with path_remove_device().

If the device was successfully initialized, it is returned.

Warning

It is an application bug to call this function on a context initialized with new_from_udev.

fn path_remove_device(&mut self, device: Device)

Remove a device from a libinput context initialized with new_from_path and added to such a context with path_add_device.

Events already processed from this input device are kept in the queue, the DeviceRemovedEvent event marks the end of events for this device.

Warning

It is an application bug to call this function on a context initialized with new_from_udev.

fn udev_assign_seat(&mut self, seat_id: &str) -> Result<(), ()>

Assign a seat to this libinput context.

New devices or the removal of existing devices will appear as events during dispatch.

udev_assign_seat succeeds even if no input devices are currently available on this seat, or if devices are available but fail to open in LibinputInterface::open_restricted.

Devices that do not have the minimum capabilities to be recognized as pointer, keyboard or touch device are ignored. /// Such devices and those that failed to open ignored until the next call to resume.

Warning

This function may only be called once per context.

fn suspend(&self)

Suspend monitoring for new devices and close existing devices.

This closes all open devices and terminates libinput but does keep the context valid to be resumed with resume.

fn resume(&mut self) -> Result<(), ()>

Resume a suspended libinput context.

This re-enables device monitoring and adds existing devices.

fn dispatch(&mut self) -> IoResult<()>

Main event dispatchment function.

Reads events of the file descriptors and processes them internally. Use next or any other function provided by the Iterator trait to retrieve the events until None is returned.

Dispatching does not necessarily queue libinput events. This function should be called immediately once data is available on the file descriptor returned by fd. libinput has a number of timing-sensitive features (e.g. tap-to-click), any delay in calling dispatch may prevent these features from working correctly.

unsafe fn fd(&self) -> RawFd

libinput keeps a single file descriptor for all events.

Call into dispatch if any events become available on this fd.

The most simple variant to check for available bytes is to use the libc:

loop {
    let mut count = 0i32;
    libc::ioctl(context.fd(), libc::FIONREAD, &mut count);
    if (count > 0) {
        context.dispatch().unwrap();
        for event in context {
            // do some processing...
        }
    }
}

For more complex operations you may wish to use other approches as event loops e.g. in the wayland-server or the tokio crates to wait for data to become available on this file descriptor.

Trait Implementations

impl Eq for Libinput

impl Debug for Libinput

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

Formats the value using the given formatter.

impl FromRaw<libinput> for Libinput

unsafe fn from_raw(ffi: *mut libinput) -> Self

Create a new instance of this type from a raw pointer.

impl AsRaw<libinput> for Libinput

fn as_raw(&self) -> *const libinput

Receive a raw pointer representing this type.

impl Userdata for Libinput

unsafe fn userdata_raw<T: 'static>(&self) -> *mut T

unsafe fn set_userdata_raw<T: 'static>(&self, ptr: *mut T)

unsafe fn userdata<T: 'static>(&self) -> Option<&T>

Receive a reference to the attached userdata, if one exists.

unsafe fn userdata_mut<T: 'static>(&mut self) -> Option<&mut T>

Receive a mutable reference to the attached userdata, if one exists.

unsafe fn set_userdata<T: 'static, U: 'static>(
    &mut self,
    new: Option<T>
) -> Option<U>

Set userdata and receive the currently set userdata

impl Clone for Libinput

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Libinput

fn drop(&mut self)

A method called when the value goes out of scope.

impl PartialEq for Libinput

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Hash for Libinput

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Iterator for Libinput

type Item = Event

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

🔬 This is a nightly-only experimental API. (iterator_step_by)

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator, 

'Zips up' two iterators into a single iterator of pairs.

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item) -> (), 

🔬 This is a nightly-only experimental API. (iterator_for_each)

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

Creates an iterator which can use peek to look at the next element of the iterator without consuming it.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that [skip]s elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that yields elements based on a predicate.

fn skip(self, n: usize) -> Skip<Self>

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

Creates an iterator that yields its first n elements.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator, 

Creates an iterator that works like map, but flattens nested structure.

fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first [None].

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item) -> (), 

Do something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 

Transforms an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool, 

Consumes an iterator, creating two collections from it.

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 

An iterator adaptor that applies a function, producing a single, final value.

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

Searches for an element of an iterator that satisfies a predicate.

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool, 

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator, 

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the minimum value with respect to the specified comparison function.

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator, 

Reverses an iterator's direction.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 

Converts an iterator of pairs into a pair of containers.

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone, 

Creates an iterator which [clone]s all of its elements.

fn cycle(self) -> Cycle<Self> where
    Self: Clone, 

Repeats an iterator endlessly.

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 

Sums the elements of an iterator.

fn product<P>(self) -> P where
    P: Product<Self::Item>, 

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord, 

Lexicographically compares the elements of this Iterator with those of another.

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Lexicographically compares the elements of this Iterator with those of another.

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are equal to those of another.

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are unequal to those of another.

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.