Struct Presentation 

#[non_exhaustive]
pub struct Presentation {
    pub title: Option<String>,
    pub description: Option<String>,
    pub icon: Option<Icon>,
    pub tint: Option<Tint>,
}

Presentation hints for one field rule.

#[non_exhaustive]: this is the type that grows every time a frontend needs a new hint, so it is built from Presentation::default and the chainable setters below rather than a struct literal. Reading the fields is unchanged.

use fig_schema::{Icon, Presentation, Tint};

let p = Presentation::default()
    .title("Audience")
    .description("Who may read this")
    .icon(Icon::Globe)
    .tint(Tint::Positive);
assert_eq!(p.title.as_deref(), Some("Audience"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

A human field label.

description: Option<String>

Help text / section subtitle.

icon: Option<Icon>

A semantic icon.

tint: Option<Tint>

A semantic tint.

Implementations

impl Presentation

pub fn title(self, title: impl Into<String>) -> Self

Set the human field label.

pub fn title_opt(self, title: Option<impl Into<String>>) -> Self

Set the label from an optional one — for a caller reading a config where the title may be absent. None leaves it unset.

pub fn description(self, description: impl Into<String>) -> Self

Set the help text.

pub fn description_opt(self, description: Option<impl Into<String>>) -> Self

Set the help text from an optional one. None leaves it unset.

pub fn icon(self, icon: impl Into<Option<Icon>>) -> Self

Set the semantic icon. Takes an Icon or an Option<Icon>.

pub fn tint(self, tint: impl Into<Option<Tint>>) -> Self

Set the semantic tint. Takes a Tint or an Option<Tint>.

Trait Implementations

impl Clone for Presentation

fn clone(&self) -> Presentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Presentation

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

Formats the value using the given formatter.

impl Default for Presentation

fn default() -> Presentation

Returns the “default value” for a type.

impl Eq for Presentation

impl PartialEq for Presentation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Presentation