Skip to main content

ClipBuilder

Struct ClipBuilder 

Source
pub struct ClipBuilder { /* private fields */ }
Expand description

Clip entry stream (§3.11) for ClipHandle::append. Each method appends one entry: a gap run or one ClipFrame.

Implementations§

Source§

impl ClipBuilder

Source

pub fn new() -> ClipBuilder

Empty builder.

Source

pub fn gap(&mut self, frames: u16) -> &mut Self

Gap run: emit nothing for frames native frames (the endpoint NAKs like an idle mouse).

Source

pub fn frame(&mut self, frame: ClipFrame) -> &mut Self

Appends frame.

Source

pub fn move_by(&mut self, dx: i16, dy: i16) -> &mut Self

Cursor-motion frame.

Source

pub fn wheel(&mut self, dz: i16) -> &mut Self

Wheel frame.

Source

pub fn pan(&mut self, dpan: i16) -> &mut Self

Pan (horizontal scroll) frame.

Source

pub fn edge(&mut self, input: impl Into<Usage>, action: Action) -> &mut Self

Frame with one edge (any input class).

Source

pub fn press(&mut self, usage: impl Into<Usage>) -> &mut Self

Frame pressing a button, key or media usage, like Device::press.

Source

pub fn release(&mut self, usage: impl Into<Usage>) -> &mut Self

Frame soft-releasing a usage (clears the injected press; a physical hold stays).

Source

pub fn force_release(&mut self, usage: impl Into<Usage>) -> &mut Self

Frame force-releasing a usage (masks a physical hold too).

Source

pub fn raw( &mut self, ep: u8, direction: Direction, bytes: impl Into<Vec<u8>>, ) -> &mut Self

Frame with one raw report (see ClipFrame::raw).

Source

pub fn transfer( &mut self, ep: u8, setup: Setup, out: impl Into<Vec<u8>>, ) -> &mut Self

Frame with one control transfer (see ClipFrame::transfer).

Source

pub fn len(&self) -> usize

Number of entries.

Source

pub fn is_empty(&self) -> bool

Whether the builder holds no entries.

Source

pub fn byte_len(&self) -> usize

Ring bytes the entries take, to check against ClipStatus::free before an append.

Source

pub fn clear(&mut self)

Clear the entries to reuse the allocation.

Trait Implementations§

Source§

impl Clone for ClipBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClipBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ClipBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ClipBuilder

Source§

impl PartialEq for ClipBuilder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClipBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more