Struct ScrollTo 

pub struct ScrollTo {
    pub x: Option<ScrollTarget>,
    pub y: Option<ScrollTarget>,
    pub animate: bool,
}

A request to move a scroll region, addressed to one axis or both.

None on an axis leaves that axis where it is, which is what lets one type serve a vertical page, a sideways strip and the rare surface that scrolls both ways without a caller ever writing a coordinate it did not mean.

Carried by a command, resolved against the frame that follows it, and refused by a region a finger is holding — an offset has one owner at a time, and the finger is the one the reader can see.

Fields

x: Option<ScrollTarget>

Where the horizontal axis is asked to go; None leaves it alone.

y: Option<ScrollTarget>

Where the vertical axis is asked to go; None leaves it alone.

animate: bool

Spring to it (what every constructor here sets) rather than arrive there.

Implementations

impl ScrollTo

pub fn y(offset: f32) -> Self

To offset offset down the page, with an animation.

pub fn x(offset: f32) -> Self

To offset offset across, with an animation.

pub fn start() -> Self

Back to where the vertical axis starts — the “back to top” button.

pub fn end() -> Self

To the far end of the vertical axis, wherever the content has got to.

pub fn and_x(self, target: ScrollTarget) -> Self

Also moves the horizontal axis to target.

pub fn and_y(self, target: ScrollTarget) -> Self

Also moves the vertical axis to target.

pub fn instant(self) -> Self

Arrive rather than travel: no animation, the offset is simply there.

What restoring a reader’s place wants. An animation there would be a list scrolling itself in front of somebody who has just come back and is looking for where they left off, and the reference draws the same line between its two verbs.

pub fn is_empty(&self) -> bool

Nothing to do: neither axis was named.

pub fn resolve(&self, area: &Scrollable, current: (f32, f32)) -> (f32, f32)

The offsets this request means for area, starting from current.

Trait Implementations

impl Clone for ScrollTo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScrollTo

impl Debug for ScrollTo

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

Formats the value using the given formatter.

impl Default for ScrollTo

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ScrollTo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScrollTo