Struct ScrollOutcome

pub struct ScrollOutcome {
    pub before: Offset,
    pub after: Offset,
    pub max_offset: Offset,
    pub changed: bool,
}

Result of applying scroll logic.

Examples

use ailloli_ui_core::{Offset, ScrollAxes, ScrollMetrics, ScrollState, Size};
let metrics = ScrollMetrics::new(Size::new(10.0, 10.0), Size::new(20.0, 20.0));
let outcome = ScrollState::new().scroll_to(Offset::new(5.0, 0.0), metrics, ScrollAxes::BOTH);
assert!(outcome.changed);

Fields

before: Offset

Offset before the operation; it may itself be out of bounds.

after: Offset

Clamped offset after the operation.

max_offset: Offset

Maximum valid offset for the enabled axes.

changed: bool

Whether before and after differ by at least 0.001 on either axis.

Implementations

impl ScrollOutcome

pub fn state(self) -> ScrollState

Converts the final offset into the next persistent scroll state.

Examples

use ailloli_ui_core::{Offset, ScrollAxes, ScrollMetrics, ScrollState, Size};
let metrics = ScrollMetrics::new(Size::new(10.0, 10.0), Size::new(20.0, 20.0));
let state = ScrollState::new().scroll_to(Offset::new(5.0, 0.0), metrics, ScrollAxes::BOTH).state();
assert_eq!(state.offset, Offset::new(5.0, 0.0));

Trait Implementations

impl Clone for ScrollOutcome

fn clone(&self) -> ScrollOutcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollOutcome

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

Formats the value using the given formatter.

impl PartialEq for ScrollOutcome

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ScrollOutcome

impl StructuralPartialEq for ScrollOutcome