Skip to main content

ScrollRequest

Enum ScrollRequest 

Source
pub enum ScrollRequest {
    ToRow {
        list_key: String,
        row: usize,
        align: ScrollAlignment,
    },
    ToRowKey {
        list_key: String,
        row_key: String,
        align: ScrollAlignment,
    },
    EnsureVisible {
        container_key: String,
        y: f32,
        h: f32,
    },
}
Expand description

What the app produces from crate::App::drain_scroll_requests. Three shapes today:

  • ScrollRequest::ToRow — “scroll the virtual list keyed list_key so row row lands per align.” Resolved during layout of the matching virtual_list / virtual_list_dyn using the live viewport and the row-height cache.
  • ScrollRequest::ToRowKey — same operation, but targets the virtual-list row by stable row identity instead of current row index. Prefer this for virtual_list_dyn when the app already has message/thread/commit ids.
  • ScrollRequest::EnsureVisible — “scroll the nearest scroll container under the node keyed container_key so the content- space rect y..y+h is visible.” Resolved during layout of the matching scroll(...) container; minimal-displacement (top edge if above viewport, bottom edge if below, no-op if already visible). Used by crate::widgets::text_area for caret-into-view on keyboard navigation, and available for any widget that needs to keep an inner anchor on screen.

Variants§

§

ToRow

Bring row of the virtual list keyed list_key into view per align.

Fields

§list_key: String
§row: usize
§

ToRowKey

Bring the row identified by row_key in the virtual list keyed list_key into view per align.

Fields

§list_key: String
§row_key: String
§

EnsureVisible

Ensure the content-space rect at y..y+h is visible inside the scroll container under the node keyed container_key. container_key is the outer widget’s key (e.g. the text_area’s key) — the resolver descends to find the nearest Kind::Scroll inside that node.

Fields

§container_key: String

Implementations§

Source§

impl ScrollRequest

Source

pub fn new( list_key: impl Into<String>, row: usize, align: ScrollAlignment, ) -> Self

Construct a ScrollRequest::ToRow. Kept for source-compat with callers that predate the enum — ScrollRequest::new(...) has always meant “scroll a virtual list to a row.”

Source

pub fn to_row_key( list_key: impl Into<String>, row_key: impl Into<String>, align: ScrollAlignment, ) -> Self

Construct a ScrollRequest::ToRowKey. Dynamic virtual lists resolve this against the same stable row identities passed to crate::virtual_list_dyn.

Source

pub fn ensure_visible(container_key: impl Into<String>, y: f32, h: f32) -> Self

Construct a ScrollRequest::EnsureVisible for the widget keyed container_key, asking the resolver to keep y..y+h (in the scroll container’s content coordinates) inside the viewport.

Trait Implementations§

Source§

impl Clone for ScrollRequest

Source§

fn clone(&self) -> ScrollRequest

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 ScrollRequest

Source§

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

Formats the value using the given formatter. Read more

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, 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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.