Struct FieldInfo

pub struct FieldInfo<'a, 'b> {

    pub owner_type_id: TypeId,
    pub name: &'b str,
    pub display_name: &'b str,
    pub description: &'b str,
    pub tag: &'b str,
    pub type_name: &'b str,
    pub doc: &'b str,
    pub value: &'a (dyn FieldValue + 'static),
    pub reflect_value: &'a (dyn Reflect + 'static),
    pub read_only: bool,
    pub immutable_collection: bool,
    pub min_value: Option<f64>,
    pub max_value: Option<f64>,
    pub step: Option<f64>,
    pub precision: Option<usize>,
}

Fields

owner_type_id: TypeId

A type id of the owner of the property.

name: &'b str

A name of the property.

display_name: &'b str

A human-readable name of the property.

description: &'b str

Description of the property.

tag: &'b str

Tag of the property. Could be used to group properties by a certain criteria or to find a specific property by its tag.

type_name: &'b str

Type name of the property.

doc: &'b str

Doc comment content.

value: &'a (dyn FieldValue + 'static)

An reference to the actual value of the property. This is “non-mangled” reference, which means that while field/fields/field_mut/fields_mut might return a reference to other value, than the actual field, the value is guaranteed to be a reference to the real value.

reflect_value: &'a (dyn Reflect + 'static)

A reference to the value casted to Reflect.

read_only: bool

A property is not meant to be edited.

immutable_collection: bool

Only for dynamic collections (Vec, etc) - means that its size cannot be changed, however the items of the collection can still be changed.

min_value: Option<f64>

A minimal value of the property. Works only with numeric properties!

max_value: Option<f64>

A minimal value of the property. Works only with numeric properties!

step: Option<f64>

A minimal value of the property. Works only with numeric properties!

precision: Option<usize>

Maximum amount of decimal places for a numeric property.

Implementations

impl FieldInfo<'_, '_>

pub fn cast_value<T>(&self) -> Result<&T, CastError>

where T: 'static,

Tries to cast a value to a given type.

Trait Implementations

impl Debug for FieldInfo<'_, '_>

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

Formats the value using the given formatter.

impl PartialEq for FieldInfo<'_, '_>

fn eq(&self, other: &FieldInfo<'_, '_>) -> 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.