Struct StructVariantInfo

pub struct StructVariantInfo { /* private fields */ }

Type info for struct variants.

Implementations

impl StructVariantInfo

pub fn new(name: &'static str, fields: &[NamedField]) -> Self

Create a new StructVariantInfo.

pub fn with_docs(self, docs: Option<&'static str>) -> Self

Available on crate feature documentation only.

Sets the docstring for this variant.

pub fn with_custom_attributes(self, custom_attributes: CustomAttributes) -> Self

Sets the custom attributes for this variant.

pub fn name(&self) -> &'static str

The name of this variant.

pub fn field_names(&self) -> &[&'static str]

A slice containing the names of all fields in order.

pub fn field(&self, name: &str) -> Option<&NamedField>

Get the field with the given name.

pub fn field_at(&self, index: usize) -> Option<&NamedField>

Get the field at the given index.

pub fn index_of(&self, name: &str) -> Option<usize>

Get the index of the field with the given name.

pub fn iter(&self) -> Iter<'_, NamedField>

Iterate over the fields of this variant.

pub fn field_len(&self) -> usize

The total number of fields in this variant.

pub fn docs(&self) -> Option<&'static str>

Available on crate feature documentation only.

The docstring of this variant, if any.

pub fn custom_attributes(&self) -> &CustomAttributes

Returns the custom attributes for this item.

pub fn get_attribute<T: Reflect>(&self) -> Option<&T>

Gets a custom attribute by type.

For dynamically accessing an attribute, see get_attribute_by_id.

pub fn get_attribute_by_id(&self, id: TypeId) -> Option<&dyn Reflect>

Gets a custom attribute by its TypeId.

This is the dynamic equivalent of get_attribute.

pub fn has_attribute<T: Reflect>(&self) -> bool

Returns true if this item has a custom attribute of the specified type.

For dynamically checking if an attribute exists, see has_attribute_by_id.

pub fn has_attribute_by_id(&self, id: TypeId) -> bool

Returns true if this item has a custom attribute with the specified TypeId.

This is the dynamic equivalent of has_attribute

Trait Implementations

impl Clone for StructVariantInfo

fn clone(&self) -> StructVariantInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructVariantInfo

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

Formats the value using the given formatter.