Struct ScriptOrigin

pub struct ScriptOrigin { /* private fields */ }

A representation of a range within Script source code.

This object points to specific span within the ScriptModule’s source code text, often highlighting identifiers and similar syntactic constructs. Generally, it can span arbitrary range of text tokens.

Unlike absolute ranges (such as 10..20 or Position::new(1, 4)..Position::new(3, 8)), the ScriptOrigin range is relative. If you edit the script’s text before, after, or inside the referenced range, this range will realign accordingly. However, if the text edits affect the ScriptOrigin bounds directly, the object will become obsolete.

In general, ScriptOrigin may represent an invalid range or become invalid over time if the source code is edited. You can check the range’s validity using the is_valid_span method, passing an instance of ModuleText: script_origin.is_valid_span(&module_text).

Note that ScriptOrigin belongs to a specific ScriptModule instance and is valid only for that module. The id function of ScriptOrigin returns a globally unique identifier for the script module to which this ScriptOrigin object belongs.

Implementations

impl ScriptOrigin

pub const fn nil() -> Self

Creates an instance of ScriptOrigin that intentionally does not point to any Script code. This serves as the Default constructor for this object.

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

Returns the script package metadata of the ScriptModule that this ScriptOrigin points to.

Returns None if the package cannot be found, for instance, if the corresponding ScriptModule has been dropped.

pub const fn is_nil(&self) -> bool

Returns true if this instance is the Nil ScriptOrigin.

Trait Implementations

impl Clone for ScriptOrigin

fn clone(&self) -> ScriptOrigin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptOrigin

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

Formats the value using the given formatter.

impl Default for ScriptOrigin

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a Range<SiteRef>> for ScriptOrigin

fn from(value: &'a SiteRefSpan) -> Self

Converts to this type from the input type.

impl<'a> From<&'a SiteRef> for ScriptOrigin

fn from(value: &'a SiteRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a TokenRef> for ScriptOrigin

fn from(value: &'a TokenRef) -> Self

Converts to this type from the input type.

impl<'a> From<Range<&'a TokenRef>> for ScriptOrigin

fn from(value: Range<&'a TokenRef>) -> Self

Converts to this type from the input type.

impl From<Range<SiteRef>> for ScriptOrigin

fn from(value: SiteRefSpan) -> Self

Converts to this type from the input type.

impl From<Range<TokenRef>> for ScriptOrigin

fn from(value: Range<TokenRef>) -> Self

Converts to this type from the input type.

impl<'a> From<RangeFrom<&'a SiteRef>> for ScriptOrigin

fn from(value: RangeFrom<&'a SiteRef>) -> Self

Converts to this type from the input type.

impl<'a> From<RangeFrom<&'a TokenRef>> for ScriptOrigin

fn from(value: RangeFrom<&'a TokenRef>) -> Self

Converts to this type from the input type.

impl From<RangeFrom<SiteRef>> for ScriptOrigin

fn from(value: RangeFrom<SiteRef>) -> Self

Converts to this type from the input type.

impl From<RangeFrom<TokenRef>> for ScriptOrigin

fn from(value: RangeFrom<TokenRef>) -> Self

Converts to this type from the input type.

impl<'a> From<RangeInclusive<&'a TokenRef>> for ScriptOrigin

fn from(value: RangeInclusive<&'a TokenRef>) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<TokenRef>> for ScriptOrigin

fn from(value: RangeInclusive<TokenRef>) -> Self

Converts to this type from the input type.

impl From<ScriptOrigin> for Origin

fn from(value: ScriptOrigin) -> Self

Converts to this type from the input type.

impl From<SiteRef> for ScriptOrigin

fn from(value: SiteRef) -> Self

Converts to this type from the input type.

impl From<TokenRef> for ScriptOrigin

fn from(value: TokenRef) -> Self

Converts to this type from the input type.

impl Hash for ScriptOrigin

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 Identifiable for ScriptOrigin

fn id(&self) -> Id

Returns the globally unique identifier of the compilation unit to which this object belongs.

impl Ord for ScriptOrigin

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 ScriptOrigin

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

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 ToSpan for ScriptOrigin

fn to_site_span(&self, code: &impl SourceCode) -> Option<SiteSpan>

Returns a SiteSpan representation of this span object.

fn is_valid_span(&self, code: &impl SourceCode) -> bool

Returns true if this span object considered valid within the code SourceCode.

fn to_position_span(&self, code: &impl SourceCode) -> Option<Range<Position>>

Returns a line-column range representation of this span object.

fn display<'a>(&self, code: &'a impl SourceCode) -> impl Debug + Display + 'a

Returns a displayable object that prints the underlying span object for debugging purposes.

impl Copy for ScriptOrigin

impl Eq for ScriptOrigin

impl StructuralPartialEq for ScriptOrigin