Skip to main content

SliverConstraints

Struct SliverConstraints 

Source
pub struct SliverConstraints {
    pub axis: ScrollAxis,
    pub scroll_offset: f64,
    pub preceding_scroll_extent: f64,
    pub overlap: f64,
    pub remaining_paint_extent: f64,
    pub cross_axis_extent: f64,
    pub viewport_main_axis_extent: f64,
    pub cache_origin: f64,
    pub remaining_cache_extent: f64,
    pub user_scroll_direction: ScrollDirection,
}
Expand description

The sliver protocol a scrolling viewport lays its children out with — a widget implements SliverWidget and overrides Widget::as_sliver to answer SliverConstraints with a SliverGeometry; a viewport lays such a child out through ChildPod::layout_sliver_child. Lifted so an app’s own sliver needs no direct frust-core dependency. What a viewport hands each sliver child: its position in the scroll and the space left to fill — Flutter’s SliverConstraints.

All extents are logical pixels along axis unless named cross_axis_*. PartialEq is what ChildPod::layout_sliver_child’s layout skip compares, so constraints carrying a NaN never compare equal and always lay out again.

Fields§

§axis: ScrollAxis

The axis the viewport scrolls along (Flutter’s axis, derived there from axisDirection).

§scroll_offset: f64

How far into this sliver the viewport’s leading edge has scrolled: 0 while the sliver’s start is on screen or ahead of it (Flutter’s scrollOffset).

§preceding_scroll_extent: f64

The scroll extent consumed by every sliver before this one (Flutter’s precedingScrollExtent); may be infinite after an unbounded sliver.

§overlap: f64

How many pixels from this sliver’s paint start an earlier sliver has already painted over, e.g. a pinned header (Flutter’s overlap).

§remaining_paint_extent: f64

How many pixels of content the sliver should consider providing — the viewport’s paint space not yet taken by earlier slivers (Flutter’s remainingPaintExtent); may be infinite for a shrink-wrapping viewport.

§cross_axis_extent: f64

The viewport’s extent across the scroll axis (Flutter’s crossAxisExtent).

§viewport_main_axis_extent: f64

The viewport’s extent along the scroll axis (Flutter’s viewportMainAxisExtent).

§cache_origin: f64

Where the cache area starts relative to scroll_offset, never positive (Flutter’s cacheOrigin).

§remaining_cache_extent: f64

How much content the sliver should provide starting at cache_origin, visible region plus cache area (Flutter’s remainingCacheExtent).

§user_scroll_direction: ScrollDirection

The direction the user is scrolling in (Flutter’s userScrollDirection).

Implementations§

Source§

impl SliverConstraints

Source

pub fn growth_direction(&self) -> GrowthDirection

Which way content grows — always GrowthDirection::Forward (Flutter’s growthDirection).

Source

pub fn as_box_constraints(&self) -> BoxConstraints

Box constraints for a box child laid out inside this sliver: tight to cross_axis_extent across the axis, unbounded along it (Flutter’s asBoxConstraints() with its default extents).

Source

pub fn debug_assert_valid(&self)

Debug-assert the constraints are well formed — Flutter’s SliverConstraints.debugAssertIsValid (including isNormalized).

Checks that scroll_offset, cross_axis_extent, viewport_main_axis_extent, remaining_paint_extent and remaining_cache_extent are non-negative (NaN fails), that cache_origin is not positive, and that preceding_scroll_extent and overlap are not NaN. Compiles to nothing without debug_assertions.

Trait Implementations§

Source§

impl Clone for SliverConstraints

Source§

fn clone(&self) -> SliverConstraints

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 Copy for SliverConstraints

Source§

impl Debug for SliverConstraints

Source§

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

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

impl PartialEq for SliverConstraints

Source§

fn eq(&self, other: &SliverConstraints) -> 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 SliverConstraints

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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