Struct circomspect_program_structure::intermediate_representation::VariableName

pub struct VariableName { /* private fields */ }

A IR variable name consists of three components.

1. The original name (obtained from the source code).
2. An optional suffix (used to ensure uniqueness when lifting to IR).
3. An optional version (applied when the CFG is converted to SSA form).

Implementations

impl VariableName

pub fn from_name<N: ToString>(name: N) -> VariableName

Returns a new variable name with the given name (without suffix or version).

pub fn name(&self) -> &String

pub fn suffix(&self) -> &Option<String>

pub fn version(&self) -> &Option<usize>

pub fn with_suffix<S: ToString>(&self, suffix: S) -> VariableName

Returns a new copy of the variable name, adding the given suffix.

pub fn with_version(&self, version: usize) -> VariableName

Returns a new copy of the variable name, adding the given version.

pub fn without_suffix(&self) -> VariableName

Returns a new copy of the variable name with the suffix dropped.

pub fn without_version(&self) -> VariableName

Returns a new copy of the variable name with the version dropped.

Trait Implementations

impl Clone for VariableName

fn clone(&self) -> VariableName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariableName

Debug for VariableName outputs the full name (including suffix and version).

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

Formats the value using the given formatter.

impl Display for VariableName

Display for VariableName only outputs the original name.

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

Formats the value using the given formatter.

impl Hash for VariableName

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,

Feeds a slice of this type into the given Hasher.

impl PartialEq<VariableName> for VariableName

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

impl StructuralEq for VariableName

impl StructuralPartialEq for VariableName