Skip to main content

SliverGeometry

Struct SliverGeometry 

Source
pub struct SliverGeometry {
    pub scroll_extent: f64,
    pub paint_extent: f64,
    pub paint_origin: f64,
    pub layout_extent: f64,
    pub max_paint_extent: f64,
    pub hit_test_extent: f64,
    pub visible: bool,
    pub has_visual_overflow: bool,
    pub scroll_offset_correction: Option<f64>,
    pub cache_extent: f64,
}
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 sliver reports back from layout: how far it scrolls, how much of the viewport it painted, and where the next sliver starts — Flutter’s SliverGeometry.

All extents are logical pixels along the constraints’ axis.

Fields§

§scroll_extent: f64

The (estimated) total scrollable extent of the sliver’s content (Flutter’s scrollExtent).

§paint_extent: f64

How much of the remaining paint extent the sliver painted — its visible size along the axis (Flutter’s paintExtent).

§paint_origin: f64

Where the sliver’s first visible pixel sits relative to its layout position, e.g. negative to paint over an earlier sliver (Flutter’s paintOrigin).

§layout_extent: f64

The distance from this sliver’s first visible pixel to the next sliver’s — usually paint_extent; less for a sliver the next one should overlap (Flutter’s layoutExtent).

§max_paint_extent: f64

The (estimated) paint extent the sliver would provide given infinite remaining paint extent (Flutter’s maxPaintExtent).

§hit_test_extent: f64

The distance from the paint start to the end of the region that accepts hits — usually paint_extent (Flutter’s hitTestExtent).

§visible: bool

Whether the sliver should be painted at all — usually paint_extent > 0 (Flutter’s visible).

§has_visual_overflow: bool

Whether the sliver painted outside its paint extent, so the viewport must clip it (Flutter’s hasVisualOverflow).

§scroll_offset_correction: Option<f64>

A non-zero amount the viewport must adjust its scroll offset by before re-running the whole layout, when the sliver found its earlier extent estimate wrong (Flutter’s scrollOffsetCorrection).

§cache_extent: f64

How much of the remaining cache extent the sliver consumed — at least layout_extent (Flutter’s cacheExtent).

Implementations§

Source§

impl SliverGeometry

Source

pub const ZERO: SliverGeometry

The geometry of an empty sliver: no extent of any kind and not visible (Flutter’s SliverGeometry.zero).

Source

pub fn new( scroll_extent: f64, paint_extent: f64, max_paint_extent: f64, ) -> SliverGeometry

A geometry with Flutter’s constructor defaults for everything but the three extents: layout_extent and hit_test_extent equal paint_extent, cache_extent equals layout_extent, visible is paint_extent > 0, and the rest is zero.

Source

pub fn debug_assert_valid(&self, constraints: &SliverConstraints)

Debug-assert the geometry is well formed and fits constraints — Flutter’s SliverGeometry.debugAssertIsValid plus the paint-extent check of RenderSliver.debugAssertDoesMeetConstraints.

Checks that scroll_extent, paint_extent, layout_extent, cache_extent and hit_test_extent are non-negative (NaN fails); that layout_extent <= paint_extent, paint_extent <= max_paint_extent, paint_extent <= constraints.remaining_paint_extent and layout_extent <= cache_extent, each within PRECISION_ERROR_TOLERANCE; and that a scroll_offset_correction is finite and non-zero. Compiles to nothing without debug_assertions.

Trait Implementations§

Source§

impl Clone for SliverGeometry

Source§

fn clone(&self) -> SliverGeometry

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 SliverGeometry

Source§

impl Debug for SliverGeometry

Source§

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

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

impl PartialEq for SliverGeometry

Source§

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

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