Struct Info

pub struct Info {
    pub unique_id: String,
    pub title: String,
    pub short_title: String,
    pub flags: Flags,
    pub type_specific: TypeSpecificInfo,
}

Owning version of InfoRef.

Fields

unique_id: String

The unique ID of the parameter.

As the name implies, each parameter’s id must be unique within the comonent’s parameters.

Note that this ID will not be presented to the user, it is only used to refer to the parameter in code.

The ID must not begin with the prefix _conformal_internal, as this is reserved for use by the Conformal library itself.

title: String

Human-readable title of the parameter.

short_title: String

A short title of the parameter.

In some hosting applications, this may appear as an abbreviated version of the title. If the title is already short, it’s okay to use the same value for title and short_title.

flags: Flags

Metadata about the parameter

type_specific: TypeSpecificInfo

Information specific to the type of parameter.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl<'a> From<&'a Info> for InfoRef<'a, String>

fn from(v: &'a Info) -> Self

Converts to this type from the input type.

impl<'a, S: AsRef<str>> From<&'a InfoRef<'a, S>> for Info

fn from(v: &'a InfoRef<'a, S>) -> Self

Converts to this type from the input type.

impl PartialEq for Info

fn eq(&self, other: &Info) -> 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 StructuralPartialEq for Info