Struct bevy_reflect::ValueInfo

pub struct ValueInfo { /* private fields */ }

A container for compile-time info related to general value types, including primitives.

This typically represents a type which cannot be broken down any further. This is often due to technical reasons (or by definition), but it can also be a purposeful choice.

For example, i32 cannot be broken down any further, so it is represented by a ValueInfo. And while String itself is a struct, its fields are private, so we don’t really treat it as a struct. It therefore makes more sense to represent it as a ValueInfo.

Implementations

impl ValueInfo

pub fn new<T: Reflect + TypePath + ?Sized>() -> Self

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

Available on crate feature documentation only.

Sets the docstring for this value.

pub fn type_path_table(&self) -> &TypePathTable

A representation of the type path of the value.

Provides dynamic access to all methods on TypePath.

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

The stable, full type path of the value.

Use type_path_table if you need access to the other methods on TypePath.

pub fn type_id(&self) -> TypeId

The TypeId of the value.

pub fn is<T: Any>(&self) -> bool

Check if the given type matches the value type.

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

Available on crate feature documentation only.

The docstring of this dynamic value, if any.

Trait Implementations

impl Clone for ValueInfo

fn clone(&self) -> ValueInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueInfo

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

Formats the value using the given formatter.