Struct TypeFamily 

pub struct TypeFamily(/* private fields */);

A set of semantically related types.

Types that can be type-casted to each other to some extent form a family of types. The semantic analyzer typically treats them as a single unified type, and the LSP server usually displays the type family to which a specific type belongs.

This approach simplifies interoperability between Rust types in scripts. For example, usize, f32, and other Rust built-in primitive numeric types form the number family of types. The script engine performs automatic type conversions between these types, allowing the end user to work with each specific numeric type as a general “number”.

When you export a type using the export macro, the Script Engine automatically creates a new type family containing just that type.

However, you can manually associate a type with an existing family using the #[export(family(<family_reference>))] macro option.

To introduce a new type family, consider using the type_family declarative macro.

The TypeFamily object provides functions to explore the types associated with the family.

The IntoIterator implementation for this object iterates over each TypeMeta associated with this family.

The Debug and Display implementations print the name of the family, and (in alternate mode) enumerate the names of all associated types.

Implementations

impl TypeFamily

pub const fn new(name: &'static str) -> Self

Creates a new TypeFamily with the specified name and without documentation.

Instances of type families should typically be stored in statics:

static FOO_FAMILY: TypeFamily = TypeFamily::new("foo");

It is recommended to use the type_family declarative macro to declare type families instead.

pub const fn with_doc(name: &'static str, doc: &'static str) -> Self

Similar to the new constructor, but allows specifying RustDoc documentation for the type family through the doc parameter.

The doc string is expected to be raw Markdown documentation text.

pub fn nil() -> &'static Self

Returns a reference to the type family of the Nil type.

pub fn dynamic() -> &'static Self

Returns a reference to the type family of the dynamic type.

pub fn fn_family() -> &'static Self

Returns a reference to the type family of function-like objects, which are objects that have invocation capabilities.

pub fn package() -> &'static Self

Returns a reference to the type family of ScriptPackage objects.

pub fn number() -> &'static Self

Returns a reference to the type family of numeric objects.

The usize, f32, and other Rust built-in numeric types belong to this family.

pub fn is_nil(&self) -> bool

Returns true if this family is the Nil Family.

pub fn is_dynamic(&self) -> bool

Returns true if this family is the Dynamic Family.

pub fn is_fn(&self) -> bool

Returns true if this family is the Functions Family.

pub fn is_package(&self) -> bool

Returns true if this family is the Packages Family.

pub fn is_number(&self) -> bool

Returns true if this family is the Numeric Family.

pub fn len(&self) -> usize

Returns the number of types associated with this family.

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

Returns the user-facing name of this family.

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

Returns the RustDoc documentation for this type family. Returns None if the family does not have specified documentation.

pub fn includes(&self, ty: &TypeId) -> bool

Returns true if this type family contains a Rust type with the specified TypeId.

Trait Implementations

impl Debug for TypeFamily

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

Formats the value using the given formatter.

impl Display for TypeFamily

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

Formats the value using the given formatter.

impl Eq for TypeFamily

impl From<&'static TypeFamily> for TypeHint

fn from(value: &'static TypeFamily) -> Self

Converts to this type from the input type.

impl Hash for TypeFamily

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a TypeFamily

type Item = &'static TypeMeta

The type of the elements being iterated over.

type IntoIter = TypeFamilyIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TypeFamily

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