Struct PackageMeta

pub struct PackageMeta { /* private fields */ }

Metadata for the ScriptPackage.

You cannot instantiate this object manually; it is created automatically by the Script Engine for each exported Script Package per crate. However, you can obtain a static reference to the PackageMeta in several ways. For instance, you can get it from the ScriptPackage::meta function of the exported package struct. You can also manually find the reference using the PackageMeta::of function.

use ad_astra::{
    export,
    runtime::{PackageMeta, ScriptPackage},
};

#[export(package)]
#[derive(Default)]
struct Package;

let package_meta = Package::meta();

let same_package =
    PackageMeta::of(package_meta.name(), &format!("={}", package_meta.version())).unwrap();

assert_eq!(package_meta, same_package);

You can use this reference to instantiate script modules or to run the LSP server.

The alternative Debug implementation for the package lists all script modules currently associated with this Script Package. The alternative Display implementation prints the canonical name of the package’s crate: <package_name>@<package_version>.

Implementations

impl PackageMeta

pub fn of(name: &str, version: &str) -> Option<&'static Self>

Looks up the PackageMeta by the package’s crate name and version.

The name should match the exact crate name specified in the crate’s Cargo.toml configuration.

The version specifies the crate version requirement. There can be multiple crates with the same name but different versions in the crate dependency graph. The format of the version string is the same as used in the [dependencies] section of Cargo.toml. For example, you can specify the version as 3.0 to match the latest minor version, or use the equality sign =2.1.5 to match a specific version exactly.

The function returns None if there are no crates with the specified name and version requirements or if the crates do not have an exported Script Package.

pub fn origin(&self) -> &'static RustOrigin

Returns the Rust source code location that points to where the package type was declared.

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

Returns the name of the crate for this package, as specified in the crate’s Cargo.toml.

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

Returns the version of the crate for this package, as specified in the crate’s Cargo.toml.

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

Returns the documentation URL of the crate for this package, as specified in the crate’s Cargo.toml.

pub fn ty(&self) -> &'static TypeMeta

Returns the type metadata of the Rust struct that has been exported as a ScriptPackage.

pub fn instance(&self) -> Cell

Returns a smart pointer to the instance of the Rust struct that represents the ScriptPackage.

The Script Engine automatically instantiates each package struct type during initialization, using the Default constructor of the Rust struct.

Through this instance, you can access the exported fields and methods of the struct. The crate’s exported global functions and statics are also available as components of this type. Additionally, dependency crates (that have exported ScriptPackage) become components of this instance.

The script code can access this instance using the crate script keyword or by referencing dependent crates (my_crate.dep_crate or crate.dep_crate).

Trait Implementations

impl Debug for PackageMeta

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

Formats the value using the given formatter.

impl Display for PackageMeta

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

Formats the value using the given formatter.

impl Hash for PackageMeta

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 Ord for PackageMeta

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PackageMeta

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.

impl PartialOrd for PackageMeta

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PackageMeta