Struct Outcome 

pub struct Outcome {
    pub via: Via,
    pub scrolled: bool,
    pub before: Option<f64>,
    pub after: Option<f64>,
    pub step: Option<f64>,
    pub warnings: Vec<String>,
}

What a scroll actually did, in the shape the response carries.

Fields

via: Via

Which mechanism produced the scroll.

scrolled: bool

True only when a scroll-bar value changed.

before: Option<f64>

Bar value before the scroll, when one could be read.

after: Option<f64>

Bar value after the scroll, when one could be read.

step: Option<f64>

Per-line fraction (0..=1) used for the AXValue write, or the value we observed before honouring the event tier. None when the result came back unreadable. Surfaced in the response for transparency.

warnings: Vec<String>

Non-fatal notes. Outcome::warnings is empty on a clean event scroll.

Implementations

impl Outcome

pub fn event(before: f64, after: f64, step: f64) -> Self

The wheel event moved the bar.

pub fn ax_scrollbar( before: f64, read_back: Option<f64>, step: f64, warnings: Vec<String>, ) -> Self

AXValue was written. read_back is the value re-read after the write.

pub fn at_limit(axis: Axis, steps: i32, value: f64, step: Option<f64>) -> Self

The bar is already at its limit, so nothing moved and nothing is wrong.

pub fn none() -> Self

The caller asked for no movement, as scroll --dx 0 --dy 0 does.

No axis is addressed, so there is no bar to report a value for. This is scrolled: false with no warning: nothing was attempted and nothing failed.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl PartialEq for Outcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Outcome