Struct openqasm::ast::Program

pub struct Program {
    pub decls: Vec<Span<Decl>>,
}

Represents a whole program with defintions and statements. The definitions and declarations may cover more than one file.

Fields

decls: Vec<Span<Decl>>

The declarations in this program.

Implementations

impl Program

pub fn type_check(&self) -> Result<(), Vec<TypeError>>

Type-check this whole program.

This will check the program for some of the following errors:

• Undefined gates, registers, or parameters,
• Overlapping or invalid definitions or names,
• Mismatched types and sizes in statements,
• Recursive gate definitions.

Notably, this does not check that arguments to gates are distinct, nor that parameters are valid (e.g free from divide-by-zero), as it does not do any evaluation. Therefore, some more errors may occur during interpretation, even if no errors are reported here.

impl Program

pub fn to_pretty(&self, width: usize) -> String

This is supported on crate feature pretty only.

Pretty-print this object to a string. For more fine-grained control, use the pretty::Pretty trait from the pretty crate directly.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Program

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a, D: DocAllocator<'a>> Pretty<'a, D, ()> for Program

fn pretty(self, alloc: &'a D) -> DocBuilder<'a, D>

Converts self into a document

impl Serialize for Program

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.