Struct ScaffoldInfo 

pub struct ScaffoldInfo { /* private fields */ }

What the Scaffold around a widget knows about itself.

Empty outside a shell — which is not the same as “a shell with nothing in it”, but the two want the same answers here, and a bar outside a shell has no drawer to open either way.

Implementations

impl ScaffoldInfo

pub fn of() -> Self

The one in force here — empty outside every ScaffoldInfo::scope.

pub fn with_drawer<Msg: Clone + 'static>(self, toggle: Msg) -> Self

Records a leading drawer and the message that toggles it.

pub fn with_end_drawer<Msg: Clone + 'static>(self, toggle: Msg) -> Self

Records a trailing drawer and the message that toggles it.

pub fn has_drawer(&self) -> bool

Whether the shell has a drawer on the leading edge.

pub fn has_end_drawer(&self) -> bool

Whether the shell has a drawer on the trailing edge.

pub fn drawer_toggle<Msg: Clone + 'static>(&self) -> Option<Msg>

The message that toggles the leading drawer, for a widget whose message type it is. None for anyone else: a widget cannot send a message of another tree’s type, so being told about it would only invite a cast.

pub fn end_drawer_toggle<Msg: Clone + 'static>(&self) -> Option<Msg>

The same for the trailing drawer.

pub fn install(self) -> ScaffoldGuard

Puts this in force until the guard is dropped.

pub fn scope<R>(self, body: impl FnOnce() -> R) -> R

Runs body with this in force, and puts back what was there.

Trait Implementations

impl Clone for ScaffoldInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ScaffoldInfo

fn default() -> Self

Returns the “default value” for a type.