Module prelude

Prelude extension - available in all contexts, defining common types, operations and constants.

Re-exports

• pub use array::array_type;
• pub use array::new_array_op;
• pub use array::ArrayOp;
• pub use array::ArrayOpDef;
• pub use array::ARRAY_TYPE_NAME;
• pub use array::NEW_ARRAY_OP_ID;

Modules

• array
  Array type and operations.

Structs

• ConstError
  Structure for holding constant usize values.
• ConstExternalSymbol
  A structure for holding references to external symbols.
• ConstString
  Structure for holding constant string values.
• ConstUsize
  Structure for holding constant usize values.
• Lift
  A node which adds a extension req to the types of the wires it is passed It has no effect on the values passed along the edge
• LiftDef
  A lift operation definition.
• MakeTuple
  An operation that packs all its inputs into a tuple.
• Noop
  A no-op operation.
• NoopDef
  A no-op operation definition.
• PRELUDE
  Prelude extension
• PRELUDE_REGISTRY
  An extension registry containing only the prelude
• TupleOpDefIter
  An iterator over the variants of TupleOpDef
• UnpackTuple
  An operation that unpacks a tuple into its components.

Enums

• TupleOpDef
  Logic extension operation definitions.

Constants

• BOOL_T
  Boolean type - Sum of two units.
• ERROR_CUSTOM_TYPE
  The custom type for Errors.
• ERROR_TYPE
  Unspecified opaque error type.
• ERROR_TYPE_NAME
  The string name of the error type.
• PANIC_OP_ID
  Name of the prelude panic operation.
• PRELUDE_ID
  Name of prelude extension.
• PRINT_OP_ID
  Name of the print operation
• QB_T
  Qubit type.
• STRING_CUSTOM_TYPE
  Custom type for strings.
• STRING_TYPE
  String type.
• STRING_TYPE_NAME
  Name of the string type.
• USIZE_T
  Unsigned size type.
• VERSION
  Extension version.

Functions

• const_fail
  A constant Either value with a failure variant.
• const_fail_tuple
  A constant Either with a row of failure values.
• const_left
  A constant Either value with a left variant.
• const_left_tuple
  A constant Either value with a row of left values.
• const_none
  A constant optional value with no value.
• const_ok
  A constant Either value with a success variant.
• const_ok_tuple
  A constant Either with a row of success values.
• const_right
  A constant Either value with a right variant.
• const_right_tuple
  A constant Either value with a row of right values.
• const_some
  A constant optional value with a given value.
• const_some_tuple
  A constant optional value with a row of values.
• either_type
  An “either” type, i.e. a Sum type with a “left” and a “right” variant.
• option_type
  An optional type, i.e. a Sum type with the second variant as the given type and the first as an empty tuple.
• sum_with_error
  Return a Sum type with the second variant as the given type and the first an Error.