Struct IdRef

pub struct IdRef<'p, 'm> { /* private fields */ }

Reference to a node, param, variable, type, package, model, etc., as it appears in the usage / call site

This may be identical to an Id, but can also be preceded by a package name (package::member).

Example values

• Implicit packages (equivalent to simple Ids): sin, a, state
• Explicit package: Lustre::add, Alu::shift_right

Usage

Like Ids, IdRefs don’t store their source span. The same tips apply.

Name resolution semantics

• If an IdRef has an explicit package name, the resolution is trivial
• If an IdRef has no explicit package name, IDs are first resolved in the current scope (local or package), and then in the Lustre:: package

Implementations

impl<'p, 'm> IdRef<'p, 'm>

pub fn new( package: Option<impl Into<Cow<'p, Id>>>, member: impl Into<Cow<'m, Id>>, ) -> Self

pub fn new_implicit(member: impl Into<Cow<'m, Id>>) -> Self

Creates an IdRef with an implicit (absent) package name

pub fn new_lustre(member: impl Into<Cow<'m, Id>>) -> Self

Creates an IdRef with Lustre:: for a package name

pub fn as_package(&self) -> Option<&Id>

pub fn as_member(&self) -> &Id

pub fn as_member_implicit(&self) -> Option<&Id>

Retrieves the member, only if this IdRef has no explicit package

Can be used to attempt local resolution of an identifier, which only makes sense when no package is specified.

pub fn member_eq(&self, other: &Id) -> bool

pub fn into_inner(self) -> (Option<Cow<'p, Id>>, Cow<'m, Id>)

Trait Implementations

impl<'p, 'm> Clone for IdRef<'p, 'm>

fn clone(&self) -> IdRef<'p, 'm>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdRef<'_, '_>

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

Formats the value using the given formatter.

impl Display for IdRef<'_, '_>

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

Formats the value using the given formatter.

impl<'m> From<&'m Id> for IdRef<'_, 'm>

Converts the Id to an IdRef using IdRef::new_implicit

fn from(value: &'m Id) -> Self

Converts to this type from the input type.

impl From<&IdRefNode> for IdRef<'_, '_>

fn from(value: &IdRefNode) -> Self

Converts to this type from the input type.

impl From<IdRefNode> for IdRef<'_, '_>

fn from(value: IdRefNode) -> Self

Converts to this type from the input type.

impl FromStr for IdRef<'_, '_>

Parses an IdRef from a &str

Most of the time, the actual Rustre parser will be used instead of this function. It exists mostly for convenience and interoperability. Please note that this implementation is infallible, and won’t check for invalid chars in identifiers.

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'p, 'm> Hash for IdRef<'p, 'm>

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<'p, 'm> PartialEq for IdRef<'p, 'm>

fn eq(&self, other: &IdRef<'p, 'm>) -> 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<'p, 'm> StructuralPartialEq for IdRef<'p, 'm>