Struct FunctionInfo

pub struct FunctionInfo {
    pub name: Cow<'static, str>,
    pub namespace: Namespace,
    pub arg_info: Vec<FunctionArgInfo>,
    pub return_info: FunctionReturnInfo,
    pub docs: Option<Cow<'static, str>>,
}

Information about a function.

Fields

name: Cow<'static, str>

The name of the function.

namespace: Namespace

The namespace of the function.

arg_info: Vec<FunctionArgInfo>

Information about the arguments of the function.

return_info: FunctionReturnInfo

Information about the return value of the function.

docs: Option<Cow<'static, str>>

Documentation for the function.

Implementations

impl FunctionInfo

pub fn new() -> FunctionInfo

Create a new function info with default values.

pub fn new_for(name: Cow<'static, str>, namespace: Namespace) -> FunctionInfo

Create a new function info with a name and namespace.

pub fn with_name(self, name: impl Into<Cow<'static, str>>) -> FunctionInfo

Set the name of the function info.

pub fn with_namespace(self, namespace: Namespace) -> FunctionInfo

Set the namespace of the function info.

pub fn add_arg<T>(self, name: Option<Cow<'static, str>>) -> FunctionInfo

where T: ArgMeta + TypedThrough + 'static,

Add an argument to the function info.

pub fn add_return<T>(self) -> FunctionInfo

where T: TypedThrough + 'static,

Add a return value to the function info.

pub fn with_docs(self, docs: impl Into<Cow<'static, str>>) -> FunctionInfo

Add documentation to the function info.

pub fn with_arg_names(self, arg_names: &[&'static str]) -> FunctionInfo

Add argument names to the function info.

If the number of argument names is less than the number of arguments, the remaining arguments will be unnamed. If the number of argument names is greater than the number of arguments, the extra argument names will be ignored.

Trait Implementations

impl Clone for FunctionInfo

fn clone(&self) -> FunctionInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionInfo

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

Formats the value using the given formatter.

impl Default for FunctionInfo

fn default() -> FunctionInfo

Returns the “default value” for a type.

impl FromReflect for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<FunctionInfo>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialReflect for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<FunctionInfo>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<FunctionInfo>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<FunctionInfo>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<FunctionInfo>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<FunctionInfo>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for FunctionInfo

where FunctionInfo: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for FunctionInfo

where FunctionInfo: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Namespace: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FunctionArgInfo>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, FunctionReturnInfo: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Cow<'static, str>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.