Enum qasmsim::grammar::lexer::Tok

#[non_exhaustive]
pub enum Tok {
    Add,
    Minus,
    Mult,
    Div,
    Pow,
    LBracket,
    RBracket,
    LBrace,
    RBrace,
    LParent,
    RParent,
    Semi,
    Comma,
    Arrow,
    Equal,
    Sin,
    Cos,
    Tan,
    Exp,
    Ln,
    Sqrt,
    ConstPi,
    U,
    CX,
    Opaque,
    Gate,
    Include,
    QReg,
    CReg,
    Measure,
    Reset,
    Barrier,
    If,
    QASMHeader,
    Version {
        repr: String,
    },
    Id {
        repr: String,
    },
    Int {
        repr: String,
    },
    Real {
        repr: String,
    },
    Str {
        repr: String,
    },
    DocStr {
        repr: String,
    },
}

Represent an OPENQASM language token.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Add

The addition operator +.

Minus

The substraction operator -.

Mult

The multiplication operator *.

Div

The division operator /.

Pow

The power operator ^.

LBracket

The left square bracket [.

RBracket

The right square bracket ].

LBrace

The left curly bracket {.

RBrace

The right curly bracket }.

LParent

The left parenthesis (.

RParent

The right parenthesis ).

Semi

A semicolon ;.

Comma

A comma ,.

Arrow

The arrow symbol ->.

Equal

The equal symbol =.

Sin

The sinus function id sin.

Cos

The cosinus function id cos.

Tan

The tangent function id tan.

Exp

The exponential function id exp.

Ln

The natural logarithm id ln.

Sqrt

The square root function id sqrt.

ConstPi

The const pi.

U

The key-word U.

CX

The key-word CX.

Opaque

The key-word opaque.

Gate

The key-word gate.

Include

The key-word include.

QReg

The key-word qreg.

CReg

The key-word creg.

Measure

The key-word measure.

Reset

The key-word reset.

Barrier

The key-word barrier.

If

The key-word if.

QASMHeader

The QASM header OPENQASM.

Version

Fields

repr: String

Version value.

The version of OPENQASM as X.Y.

Id

Fields

repr: String

Identifier value.

An identifier. Identifiers in OPENQASM must start with underscore or a lower-case letter and may be followed by alphanumeric character, either upper or lower case.

Int

Fields

repr: String

String representation of the interger as it appears in the source code.

An integer number.

Real

Fields

repr: String

String representation of the real number as it appears in the source code.

A real number.

Str

Fields

repr: String

The string as it appears in the source code.

A string of unicode characters.

DocStr

Fields

repr: String

The string as it appears in the source code after stripping the comment marks \\ and including new lines. For instance, consider the following definition:

// The identity gate, matching the matrix:
// \[
//   \mathbb{I} =
//   \begin{bmatrix}
//     1 & & \\
//     & \ddots & \\
//     & & 1
//   \end{bmatrix}
// \]
gate id q {}

The DocString representation looks like:

 The identity gate, matching the matrix:
 \[
   \mathbb{I} =
   \begin{bmatrix}
     1 & & \\
     & \ddots & \\
     & & 1
   \end{bmatrix}
 \]

Notice the space preceding each line.

A string representing the documentation of a gate.

Trait Implementations

impl Clone for Tok

fn clone(&self) -> Tok

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tok

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

Formats the value using the given formatter.

impl Display for Tok

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

Formats the value using the given formatter.

impl Hash for Tok

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 PartialEq for Tok

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

impl StructuralEq for Tok

impl StructuralPartialEq for Tok