Expand description
This crate is the primary Rust API for interacting with Rigetti products. Specifically, this
crate allows you to run Quil programs against real QPUs or a QVM
using Executable.
Re-exports§
pub use quil_rs;
Modules§
- build_
info - Build information about the crate and environment in which it was built.
- client
- This module provides methods for getting clients for the
desired API (e.g.
gRPCorOpenAPI) and will properly initialize those clients (e.g. with authentication metadata). - compiler
- This module contains functionality used to compile Quil programs for execution on QCS quantum processors.
- diagnostics
- Produce diagnostic information about the crate and its runtime environment in order to aid in debugging and remote user support.
- qpu
- This module contains all the functionality for running Quil programs on a real QPU. Specifically,
the [
Execution] struct in this module. - qvm
- This module contains all the functionality for running Quil programs on a QVM. Specifically,
the [
Execution] struct in this module.
Structs§
- Executable
- The builder interface for executing Quil programs on QVMs and QPUs.
- Execution
Data - The result of executing an
Executable - JobHandle
- The result of calling
Executable::submit_to_qpu. Represents a quantum program running on a QPU. Can be passed toExecutable::retrieve_resultsto retrieve the results of the job. - Register
Map - A mapping of a register name (ie. “ro”) to a
RegisterMatrixcontaining the values for the register.
Enums§
- Error
- The possible errors which can be returned by
Executable::execute_on_qpuandExecutable::execute_on_qvm.. - Register
Data - Data resulting from
Executable::execute_on_qvm - Register
Matrix - An enum representing every possible register type as a 2 dimensional matrix.
- Register
Matrix Conversion Error - Errors that may occur when trying to build a
RegisterMatrixfrom execution data - Result
Data - Represents the two possible types of data returned from either the QVM or a real QPU. Each variant contains the original data returned from its respective executor.
- Service
- The external services that this SDK may connect to. Used to differentiate between networking
issues in
Error::Connection.
Type Aliases§
- Execution
Result - The
Resultfrom executing on a QPU or QVM.