Struct rustre_core::id::Id

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

Name of a node, param, variable, type, package, model, etc., as it appears in the declaration

This is simply a cheap newtype around String.

Example values

• Nodes: sin, adder, map
• Variables: a, b, cin
• Types: state
• Packages: Lustre

Usage

Ids do not remember their source span. Therefore, queries that rely on it may want to require both to be given, or to compute the Id inside them. Ids without an accompanying span should only be used as inputs to query that don’t report the errors themselves.

Implementations

impl Id

pub const LUSTRE_PACKAGE: &'static Self = _

pub const fn from_str(str: &str) -> &Self

Trait Implementations

impl Clone for Box<Id>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'a> Default for &'a Id

fn default() -> Self

Returns the “default value” for a type.

impl Default for Box<Id>

fn default() -> Self

Returns the “default value” for a type.

impl Display for Id

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

Formats the value using the given formatter.

impl<'a> From<&'a Id> for Cow<'a, Id>

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

Converts to this type from the input type.

impl<'a> From<&'a IdNode> for Box<Id>

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

Converts to this type from the input type.

impl<'a> From<&'a Ident> for &'a Id

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

Converts to this type from the input type.

impl<'a> From<&'a Ident> for Box<Id>

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

Converts to this type from the input type.

impl<'a> From<&'a str> for &'a Id

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

Converts to this type from the input type.

impl<'p, 'm> From<&'m Id> for IdRef<'p, '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<Box<str, Global>> for Box<Id>

fn from(value: Box<str>) -> Self

Converts to this type from the input type.

impl From<IdNode> for Box<Id>

fn from(value: IdNode) -> Self

Converts to this type from the input type.

impl From<Ident> for Box<Id>

fn from(value: Ident) -> Self

Converts to this type from the input type.

impl From<String> for Box<Id>

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Id

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

Feeds this value into the given Hasher.

impl Ord for Id

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

This method returns an Ordering between self and other.

impl PartialEq<Id> for Id

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Id> for Id

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ToOwned for Id

type Owned = Box<Id, Global>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for Id

impl StructuralEq for Id

impl StructuralPartialEq for Id