Struct Door 

pub struct Door { /* private fields */ }

A capability and its resolution: the one thing a view asks before drawing a privileged control.

Implementations

impl Door

pub fn new(capability: Capability, resolution: Resolution) -> Door

The door for capability as resolution answers it.

pub fn granted(capability: Capability) -> Door

A capability the app holds.

pub fn grantable(capability: Capability, words: impl Into<String>) -> Door

A capability this person must grant first, in words.

pub fn unavailable(capability: Capability, reason: impl Into<String>) -> Door

A capability nothing can reach now, with one sentence of why.

pub fn capability(&self) -> Capability

What capability this door is about.

pub fn resolution(&self) -> &Resolution

The resolution the platform gave.

pub fn is_granted(&self) -> bool

Whether the real control may be drawn and its verb may run.

pub fn is_grantable(&self) -> bool

Whether the surface must offer the explicit grant step.

pub fn grant_words(&self) -> Option<&str>

The grant step’s words, when the capability is grantable.

pub fn unavailable_reason(&self) -> Option<&str>

Why the capability is unavailable, when it is.

pub fn remedy(&self) -> Option<&str>

What would make the capability available, when the platform names it.

pub fn face<T>( &self, granted: impl FnOnce() -> T, grantable: impl FnOnce(&str) -> T, unavailable: impl FnOnce(&str, Option<&str>) -> T, ) -> T

Draw one of the three faces. A view that goes through here cannot draw the granted control for a capability it does not hold.

pub fn control<T>(&self, build: impl FnOnce() -> T) -> Option<T>

The control when — and only when — the capability is granted. The grantable and unavailable faces draw no control through this shorthand; they need their own sentence or grant step, so use face for them.

Trait Implementations

impl Clone for Door

fn clone(&self) -> Door

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Door

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

Formats the value using the given formatter.

impl PartialEq for Door

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Door

impl StructuralPartialEq for Door