Struct input::Libinput [−][src]
pub struct Libinput { /* fields omitted */ }
Expand description
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.
Implementations
pub fn new_with_udev<I: LibinputInterface + 'static>(interface: I) -> Libinputⓘ
pub fn new_with_udev<I: LibinputInterface + 'static>(interface: I) -> 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.
Safety
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.
pub fn new_from_path<I: 'static + LibinputInterface>(interface: I) -> Libinputⓘ
pub fn new_from_path<I: 'static + LibinputInterface>(interface: I) -> 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
)
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
.
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
.
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.
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
.
Resume a suspended libinput context.
This re-enables device monitoring and adds existing devices.
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.
👎 Deprecated since 0.4.1: Use the provided AsRawFd implementation
Use the provided AsRawFd implementation
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
nix::poll
:
use input::{Libinput, LibinputInterface};
use nix::poll::{poll, PollFlags, PollFd};
let mut input = Libinput::new_with_udev(Interface);
input.udev_assign_seat("seat0").unwrap();
let pollfd = PollFd::new(input.as_raw_fd(), PollFlags::POLLIN);
while poll(&mut [pollfd], -1).is_ok() {
input.dispatch().unwrap();
for event in &mut input {
// 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.
Safety
See AsRawFd
Create a new instance of this type from a raw pointer.
Warning
If you make use of Userdata
make sure you use the correct types
to allow receiving the set userdata. When dealing with raw pointers initialized by other
libraries this must be done extra carefully to select a correct representation.
If unsure using ()
is always a safe option..
Safety
If the pointer is pointing to a different struct, invalid memory or NULL
the returned
struct may panic on use or cause other undefined behavior.
Trait Implementations
Advances the iterator and returns the next value. Read more
Returns the bounds on the remaining length of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
Consumes the iterator, returning the last element. Read more
iter_advance_by
)Advances the iterator by n
elements. Read more
Returns the n
th element of the iterator. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0[src]fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
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. Read more
1.0.0[src]fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
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. Read more
iter_intersperse
)Creates a new iterator which places a copy of separator
between adjacent
items of the original iterator. Read more
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
iter_intersperse
)Creates a new iterator which places an item generated by separator
between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n
elements. Read more
Creates an iterator that yields the first n
elements, or fewer
if the underlying iterator ends sooner. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator that flattens nested structure. Read more
Does something with each element of an iterator, passing the value on. Read more
Transforms an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
iter_partition_in_place
)Reorders the elements of this iterator in-place according to the given predicate,
such that all those that return true
precede all those that return false
.
Returns the number of true
elements found. Read more
iter_is_partitioned
)Checks if the elements of this iterator are partitioned according to the given predicate,
such that all those that return true
precede all those that return false
. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
iterator_try_reduce
)Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
try_find
)Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
1.0.0[src]fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
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. Read more
Returns the maximum element of an iterator. Read more
Returns the minimum element of an iterator. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Reverses an iterator’s direction. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
Lexicographically compares the elements of this Iterator
with those
of another. Read more
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
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. Read more
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
iter_order_by
)1.5.0[src]fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
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. Read more
1.5.0[src]fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
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. Read more
1.5.0[src]fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
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. Read more
1.5.0[src]fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
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. Read more
is_sorted
)Checks if the elements of this iterator are sorted. Read more
is_sorted
)Checks if the elements of this iterator are sorted using the given comparator function. Read more
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
is_sorted
)Checks if the elements of this iterator are sorted using the given key extraction function. Read more
Auto Trait Implementations
impl !RefUnwindSafe for Libinput
impl !UnwindSafe for Libinput
Blanket Implementations
Mutably borrows from an owned value. Read more