Struct InfoRef

pub struct InfoRef<'a, S> {
    pub unique_id: &'a str,
    pub title: &'a str,
    pub short_title: &'a str,
    pub flags: Flags,
    pub type_specific: TypeSpecificInfoRef<'a, S>,
}

Information about a parameter.

This is a non-owning reference type.

If you are referencing static data, use StaticInfoRef below for simplicity.

This references data with lifetime 'a. Here the S represents the type of strings, this generally will be either &'a str or String.

Fields

unique_id: &'a str

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: &'a str

Human-readable title of the parameter.

short_title: &'a str

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: TypeSpecificInfoRef<'a, S>

Information specific to the type of parameter.

Trait Implementations

impl<'a, S: Clone> Clone for InfoRef<'a, S>

fn clone(&self) -> InfoRef<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for InfoRef<'a, S>

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<'a, S: PartialEq> PartialEq for InfoRef<'a, S>

fn eq(&self, other: &InfoRef<'a, S>) -> 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<'a, S> StructuralPartialEq for InfoRef<'a, S>