Struct Field 

pub struct Field<'a> {
    pub kind: FieldKind,
    pub name: &'a str,
    pub label: &'a str,
    pub hint: Option<&'a str>,
    pub error: Option<&'a str>,
    pub required: bool,
    pub extended: bool,
}

One field of a form.

Borrowed rather than owned: a description is built, read once by a renderer, and dropped. Nothing here outlives the screen it describes.

Fields

kind: FieldKind

What kind of value it takes.

name: &'a str

The name the value is submitted under.

label: &'a str

What the user is asked for.

hint: Option<&'a str>

Standing help, shown whether or not anything is wrong.

error: Option<&'a str>

What is currently wrong with the value.

required: bool

Whether the form refuses to submit without it.

extended: bool

Whether the field lives behind a “more options” disclosure.

Implementations

impl<'a> Field<'a>

pub const fn new(kind: FieldKind, name: &'a str, label: &'a str) -> Self

A plain required-nothing field of the given kind.

pub const fn invalid(&self) -> bool

Whether the field is currently reporting a problem.

Read this rather than testing error.is_some() at each renderer: the error state has to mark the field’s whole group and not only the message, because a renderer with no descendant selectors (egui, a terminal) cannot find the group from the message. goingson already marks the group and Balanced Breakfast does not, so goingson’s shape is the one taken here.

Trait Implementations

impl<'a> Clone for Field<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Field<'a>

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Field<'a>

impl<'a> Hash for Field<'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 Field<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Field<'a>