Struct RustOrigin

pub struct RustOrigin {
    pub package: Option<(&'static str, &'static str)>,
    pub code: Option<RustCode>,
}

A pointer to a specific location in the Rust source code.

This object points to a particular place in a Rust file and represents the origin of an exported Rust construct or a part of it.

Typically, you don’t need to create this object manually. The export macro generates static instances of RustOrigin during the introspection of Rust items. These instances are created in static memory by the export system. Therefore, you would generally use &'static RustOrigin references wrapped in Origin.

Fields

package: Option<(&'static str, &'static str)>

The name and version of the crate to which the Rust file belongs.

code: Option<RustCode>

The actual reference to the Rust file within the crate.

Implementations

impl RustOrigin

pub fn nil() -> &'static Self

Returns a RustOrigin that intentionally does not point to any Rust code. This is the Default value of this object.

pub fn is_nil(&self) -> bool

Returns true if this instance is the Nil RustOrigin.

pub fn package(&self) -> Option<&'static PackageMeta>

Returns the script package metadata of the crate that this RustOrigin points to.

Returns None if the package is not specified or if the crate is not a script package.

pub fn blame<T>(&self, message: &str) -> T

This function is guaranteed to panic with the provided message.

Unlike a normal panic!, the stack trace for this panic will typically start from the Rust code that this RustOrigin points to.

Trait Implementations

impl Clone for RustOrigin

fn clone(&self) -> RustOrigin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustOrigin

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

Formats the value using the given formatter.

impl Default for RustOrigin

fn default() -> Self

Returns the “default value” for a type.

impl Display for RustOrigin

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

Formats the value using the given formatter.

impl From<&'static RustOrigin> for Origin

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

Converts to this type from the input type.

impl Hash for RustOrigin

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 RustOrigin

fn cmp(&self, other: &RustOrigin) -> 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 RustOrigin

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 RustOrigin

fn partial_cmp(&self, other: &RustOrigin) -> 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 Copy for RustOrigin

impl Eq for RustOrigin