Struct CommitOutcome 

pub struct CommitOutcome {
    pub committed: bool,
    pub reverted: bool,
    pub stored: Option<String>,
    pub display: Option<String>,
    pub writes: Vec<(u32, String)>,
}

What a commit did.

Fields

committed: bool

Whether the cascade ran to the end. True even when a hook refused, which is what makes focus proceed either way.

reverted: bool

Whether a hook refused and the field was put back to its stored value.

stored: Option<String>

The value now stored, when one was stored.

display: Option<String>

A display string a formatting hook produced, which does not change the stored value.

Meaningful only when committed and not reverted. A commit that ran no hooks because the value had not moved says nothing about what the field shows, and a reader must not take its None for “show the raw value”: the formatting hook runs on a change. CommitOutcome::formats is that question asked directly.

writes: Vec<(u32, String)>

Values a calculation asked to be written to other fields.

Implementations

impl CommitOutcome

pub fn unchanged() -> CommitOutcome

The answer for a field whose value had not changed: nothing ran.

pub fn keeps_focus(&self) -> bool

Whether the field that just committed should keep the keyboard.

True exactly when a hook refused; see the module documentation.

pub fn formats(&self) -> bool

Whether this outcome decides what the field displays.

The distinction display alone cannot make: a None from a commit that ran means “no formatter, draw the raw value” and must erase any earlier answer, while a None from a commit that never ran — because the value had not moved, or because a gate refused — means nothing at all and must leave the field showing what it was showing. Only the first regenerates the appearance.

Trait Implementations

impl Clone for CommitOutcome

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 CommitOutcome

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

Formats the value using the given formatter.

impl Eq for CommitOutcome

impl PartialEq for CommitOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommitOutcome