std.reflect

API summary (generated from the Beans source by npm run coverage): 7 package functions · 18 types · 94 instance methods · 40 enum variants.

std.reflect provides safe runtime metadata and checked dynamic actions. See the reflection guide for examples, ownership rules, and limits.

import std.reflect

Registry functions

pub fn value<T>(move item: T) -> Value
pub fn types() -> List<Type>
pub fn find_type(qualified_name: string) -> Option<Type>
pub fn functions() -> List<Function>
pub fn find_function(qualified_name: string) -> Option<Function>
pub fn annotation_types() -> List<AnnotationType>
pub fn find_annotation_type(qualified_name: string) -> Option<AnnotationType>

Use the contextual type_of(T) builtin for a type known at compile time.

Type and member descriptors

pub class Type
pub fn qualified_name() -> string
pub fn name() -> string
pub fn kind() -> Kind
pub fn type_arguments() -> List<Type>
pub fn base_type() -> Option<Type>
pub fn interfaces() -> List<Type>
pub fn is_assignable_from(other: Type) -> bool
pub fn declared_fields() -> List<Field>
pub fn fields() -> List<Field>
pub fn field(name: string) -> Option<Field>
pub fn declared_methods() -> List<Method>
pub fn methods() -> List<Method>
pub fn method(name: string) -> Option<Method>
pub fn initializer() -> Option<Initializer>
pub fn variants() -> List<Variant>
pub fn annotations() -> List<Annotation>
pub fn variant(name: string) -> Option<Variant>

pub class Field
pub fn name() -> string
pub fn type() -> Type
pub fn declaring_type() -> Type
pub fn is_public() -> bool
pub fn has_default() -> bool
pub fn get(receiver: Value) -> Result<Value, ReflectError>
pub fn set(receiver: Value, move value: Value) -> Result<bool, ReflectError>
pub fn annotations() -> List<Annotation>

pub class Method
pub fn name() -> string
pub fn declaring_type() -> Type
pub fn result_type() -> Type
pub fn is_public() -> bool
pub fn is_static() -> bool
pub fn is_async() -> bool
pub fn is_generic() -> bool
pub fn parameters() -> List<Parameter>
pub fn call(receiver: Value, move arguments: List<Value>) -> Result<Value, ReflectError>
pub fn call_static(move arguments: List<Value>) -> Result<Value, ReflectError>
pub fn annotations() -> List<Annotation>

pub class Initializer
pub fn declaring_type() -> Type
pub fn is_public() -> bool
pub fn is_async() -> bool
pub fn is_generic() -> bool
pub fn parameters() -> List<Parameter>
pub fn annotations() -> List<Annotation>
pub fn call(move arguments: List<Value>) -> Result<Value, ReflectError>

pub class Variant
pub fn name() -> string
pub fn declaring_type() -> Type
pub fn parameters() -> List<Parameter>
pub fn annotations() -> List<Annotation>
pub fn make(move arguments: List<Value>) -> Result<Value, ReflectError>

pub class Function
pub fn qualified_name() -> string
pub fn name() -> string
pub fn result_type() -> Type
pub fn is_public() -> bool
pub fn is_async() -> bool
pub fn is_generic() -> bool
pub fn parameters() -> List<Parameter>
pub fn call(move arguments: List<Value>) -> Result<Value, ReflectError>
pub fn annotations() -> List<Annotation>

pub class Parameter
pub fn name() -> string
pub fn type() -> Type
pub fn passing() -> Passing
pub fn annotations() -> List<Annotation>

Dynamic values

pub class Value
pub fn type() -> Type
pub fn copy() -> Value
pub fn is_type(wanted: Type) -> bool

value(item) transfers its argument into the box. A checked as? copies a copyable payload. Write move boxed as? T to take a move-only payload.

Annotation descriptors

pub class AnnotationType
pub fn qualified_name() -> string
pub fn name() -> string
pub fn is_public() -> bool
pub fn is_repeatable() -> bool
pub fn retention() -> string
pub fn targets() -> List<string>
pub fn fields() -> List<AnnotationField>
pub fn field(name: string) -> Option<AnnotationField>
pub fn annotations() -> List<Annotation>

pub class AnnotationField
pub fn name() -> string
pub fn type() -> Type
pub fn has_default() -> bool
pub fn default_value() -> Option<AnnotationValue>

pub class Annotation
pub fn qualified_name() -> string
pub fn name() -> string
pub fn type() -> AnnotationType
pub fn arguments() -> List<AnnotationArgument>
pub fn argument(name: string) -> Option<AnnotationArgument>

pub class AnnotationArgument
pub fn name() -> string
pub fn type() -> Type
pub fn value() -> AnnotationValue

pub class AnnotationValue
pub fn kind() -> AnnotationValueKind
pub fn type() -> Type
pub fn text() -> string
pub fn as_bool() -> Option<bool>
pub fn as_int() -> Option<int>
pub fn as_string() -> Option<string>
pub fn items() -> List<AnnotationValue>

Errors and enums

pub class ReflectError
pub fn kind() -> ErrorKind
pub fn message() -> string

Kind has unit, boolean, signed_integer, unsigned_integer, floating, decimal, string, class_type, interface_type, struct_type, union_type, enum_type, list, map, option, result, fixed_array, slice, raw_pointer, function_type, and other.

Passing has borrowed, taken, and mutable.

AnnotationValueKind has boolean, signed_integer, unsigned_integer, floating, decimal, string, enum_value, list, and other.

ErrorKind has missing, inaccessible, receiver_type, value_type, unsupported, argument_count, and failed.