Struct SheetSpec 

pub struct SheetSpec {
    pub content: SheetContent,
    pub detents: Vec<Detent>,
    pub selected: Option<Detent>,
    pub grabber: bool,
    pub scrolling_expands: bool,
    pub largest_undimmed: Option<Detent>,
    pub corner_radius: Option<f64>,
    pub dismissible: bool,
    pub tint: Option<u32>,
    pub dark: Option<bool>,
    /* private fields */
}

What a sheet asks: its SheetContent, the detents it rests at and how its sheet chrome behaves.

Validated when submitted (show_sheet), before any platform API is touched — see Self::validate.

Fields

content: SheetContent

What the sheet shows.

detents: Vec<Detent>

The heights the sheet may rest at, smallest first by convention; non-empty, no duplicates. Default [Medium, Large].

selected: Option<Detent>

The detent the sheet opens at; None lets the platform choose (the smallest). Must be one of Self::detents.

grabber: bool

Show the grabber bar at the top edge (default true).

scrolling_expands: bool

Whether scrolling to a scroll view’s edge grows the sheet to its next detent instead of scrolling (UIKit’s prefersScrollingExpandsWhenScrolledToEdge; default true).

largest_undimmed: Option<Detent>

The largest detent at which the content behind the sheet stays undimmed and interactive; None dims at every detent. Must be one of Self::detents.

corner_radius: Option<f64>

The sheet’s corner radius in points; None keeps the system radius.

dismissible: bool

Whether the user may swipe the sheet away — answered as SheetOutcome::Dismissed(DismissReason::User). false leaves only an action or a programmatic dismissal (default true).

tint: Option<u32>

A packed ARGB tint the Default-role action rows (and any other tint-following chrome) wear; None keeps the system tint. With the frust-api feature, SheetSpec::with_theme fills it (and Self::dark) from the active theme.

dark: Option<bool>

Pin the sheet’s light/dark appearance; None follows the system.

Implementations

impl SheetSpec

pub fn with_theme(self, theme: &Theme) -> Self

Fold the active theme into the sheet — the theme ladder’s representative subset, as for every control: SheetSpec::tint from scheme().primary (the accent ink the Default-role rows wear) and SheetSpec::dark from the theme’s brightness (L1).

impl SheetSpec

pub fn new(content: SheetContent) -> Self

A dismissible [Medium, Large] sheet with a grabber, showing content.

pub fn with_detents(self, detents: impl IntoIterator<Item = Detent>) -> Self

Replace the detents.

pub fn with_selected(self, detent: Detent) -> Self

Open at detent (one of Self::detents).

pub fn with_dismissible(self, dismissible: bool) -> Self

Set Self::dismissible.

pub fn on_detent( self, listener: impl Fn(Detent) + Send + Sync + 'static, ) -> Self

Stream the user’s detent changes into listener — intermediate events while the sheet stays live, never terminal outcomes. Called on the platform’s main thread (frust’s UI thread), once per change the user makes (a drag, a grabber tap); a programmatic SheetHandle::select_detent is not echoed back, following UIKit.

pub fn validate(&self) -> Result<(), PresentError>

The submit-time validation: the content is not empty (a non-empty title or message, an image or an action) and any image is non-empty bytes; at most MAX_SHEET_ACTIONS actions, every action id non-empty and unique; at least one detent, no duplicates, every Detent::Custom fraction finite with 0 < f <= 1; selected and largest_undimmed, when given, among detents; a corner_radius, when given, finite and non-negative.

Errors

PresentError::InvalidSpec naming the first rule broken.

Trait Implementations

impl Clone for SheetSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SheetSpec

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

Formats the value using the given formatter.

impl PartialEq for SheetSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SheetSpec