Struct Act 

pub struct Act<'a> {
    pub label: &'a str,
    pub key: Option<&'a str>,
    pub tone: Tone,
    pub state: Option<State>,
    pub hint: Option<&'a str>,
}

Fields

label: &'a str

What the control says.

key: Option<&'a str>

The key that reaches it where a host has keys.

The one member written for a terminal before there was one. A webview hangs it off accesskey or ignores it; a terminal has nothing else to offer, so this is the whole of how a control is reached there.

tone: Tone

What pressing it means. Tone::Danger is the destructive one.

state: Option<State>

Disabled, or nothing said.

State::Disabled is what changes what a renderer may do: see State::suppresses_interaction, which is what says a disabled control is drawn and not reachable. It was the only member from 0.19.0 to 0.40.0, and a control’s focus is not sayable here at all — see the crate header, “Reach, focus and the focus ring”.

hint: Option<&'a str>

A sentence that is always true of this control, shown rather than hunted for.

Standing help, not a message and not a tooltip. Half the hosts that read this have no pointer: a hover is one spelling of it, and the shipped apps reached for that spelling only because egui and a browser both had one. What is being said is that the sentence is true, never that it is hidden until a pointer arrives.

Why it is here rather than a layer up

It was in quasi_router::Act alone until 0.40.0, and each renderer drew it for itself: makeover_tui had no hint to read, so quasi-tui built the muted line, and quasi-immediate called on_hover_text outside crate::Act rather than inside it. Field::hint was here the whole time, so the same idea sat at two layers depending on which thing carried it, and a host that was not quasi could say it of a field and not of a control.

What kept it out was price rather than doubt: this crate declares links, so a member here moves 25 manifests across 12 repos. That is a release’s forward-fix pass, which is a cost and was being read as a barrier.

What a renderer owes it

Somewhere to put it, or nothing. Dropping it is legitimate; drawing it instead of the label is not, and neither is drawing it in a way that takes it out of the accessible tree, which is the failure title alone has on a browser. Nothing may live only in a hint.

None is a control whose label is the whole of it, which is nearly all of them.

Added 0.40.0.

Implementations

impl<'a> Act<'a>

pub const fn new(label: &'a str) -> Self

An ordinary control, reachable, with no key.

pub const fn hinted(self, hint: &'a str) -> Self

The sentence that is always true of it; see hint.

A renderer with nowhere to put it drops it, so this must never be the only place a fact appears.

pub const fn key(self, key: &'a str) -> Self

The key that reaches it.

pub const fn tone(self, tone: Tone) -> Self

What pressing it means.

pub const fn state(self, state: State) -> Self

Focus, or disabled.

pub fn disabled(&self) -> bool

Whether the control is drawn and does not answer.

Trait Implementations

impl<'a> Clone for Act<'a>

fn clone(&self) -> Act<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Act<'a>

impl<'a> Debug for Act<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Act<'a>

impl<'a> Hash for Act<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Act<'a>

fn eq(&self, other: &Act<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Act<'a>