Struct Identifier

Source
pub struct Identifier { /* private fields */ }
Expand description

A simple identifier (not an expression, not a variable with sections)

Used for names that appear in various contexts:

  • Variable names: x, my_var
  • Function names: my_function
  • Allocator names: omp_default_mem_alloc
  • Mapper names: my_mapper
  • User-defined reduction operators: my_reduction_op

§Learning: Newtype Pattern

This is a “newtype” - a struct with a single field that wraps another type. Why not just use &str directly?

  1. Type safety: Can’t accidentally pass an expression where identifier expected
  2. Semantic clarity: Code documents intent
  3. Future extension: Can add validation, normalization, etc.
  4. Zero cost: Compiler optimizes away the wrapper

§Example

use roup::ir::Identifier;

let id = Identifier::new("my_var");
assert_eq!(id.name(), "my_var");
assert_eq!(format!("{}", id), "my_var");

Implementations§

Source§

impl Identifier

Source

pub fn new(name: impl Into<String>) -> Self

Create a new identifier

The name is trimmed of whitespace.

§Example
use roup::ir::Identifier;

let id = Identifier::new("  my_var  ");
assert_eq!(id.name(), "my_var");
Source

pub fn name(&self) -> &str

Get the identifier name

Source

pub fn as_str(&self) -> &str

Get the identifier as a string slice

Trait Implementations§

Source§

impl Clone for Identifier

Source§

fn clone(&self) -> Identifier

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Identifier

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Identifier

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for Identifier

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Identifier> for ClauseItem

Source§

fn from(id: Identifier) -> Self

Converts to this type from the input type.
Source§

impl From<Identifier> for Variable

Source§

fn from(id: Identifier) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Identifier

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl Hash for Identifier

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Identifier

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Identifier

Source§

impl StructuralPartialEq for Identifier

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.