Struct IBMQuantumClient 

pub struct IBMQuantumClient { /* private fields */ }

Client for interacting with IBM Quantum

Implementations

impl IBMQuantumClient

pub fn new(token: &str) -> DeviceResult<Self>

Create a new IBM Quantum client with the given access token (legacy method)

Note: This method does not support automatic token refresh. For production use, prefer new_with_api_key which supports auto-refresh.

pub async fn new_with_api_key(api_key: &str) -> DeviceResult<Self>

Create a new IBM Quantum client with an API key

This method exchanges the API key for an access token and supports automatic token refresh when the token expires.

pub async fn new_with_config(config: IBMAuthConfig) -> DeviceResult<Self>

Create a new IBM Quantum client with full authentication configuration

pub async fn new_with_config_and_retry( config: IBMAuthConfig, retry_config: IBMRetryConfig, ) -> DeviceResult<Self>

Create a new IBM Quantum client with authentication and retry configuration

pub const fn set_retry_config(&mut self, config: IBMRetryConfig)

Set retry configuration

pub const fn retry_config(&self) -> &IBMRetryConfig

Get current retry configuration

pub async fn refresh_token(&self) -> DeviceResult<()>

Refresh the access token if it’s expired or about to expire

pub async fn is_token_valid(&self) -> bool

Check if the current token is valid

pub async fn token_info(&self) -> TokenInfo

Get token expiration information

pub async fn list_backends_with_retry(&self) -> DeviceResult<Vec<IBMBackend>>

List all available backends with automatic retry

pub async fn list_backends(&self) -> DeviceResult<Vec<IBMBackend>>

List all available backends

pub async fn get_backend(&self, backend_name: &str) -> DeviceResult<IBMBackend>

Get details about a specific backend

pub async fn submit_circuit( &self, backend_name: &str, config: IBMCircuitConfig, ) -> DeviceResult<String>

Submit a circuit to be executed on an IBM Quantum backend

pub async fn get_job_status(&self, job_id: &str) -> DeviceResult<IBMJobStatus>

Get the status of a job

pub async fn get_job_result(&self, job_id: &str) -> DeviceResult<IBMJobResult>

Get the results of a completed job

pub async fn wait_for_job( &self, job_id: &str, timeout_secs: Option<u64>, ) -> DeviceResult<IBMJobResult>

Wait for a job to complete with timeout

pub async fn submit_circuits_parallel( &self, backend_name: &str, configs: Vec<IBMCircuitConfig>, ) -> DeviceResult<Vec<String>>

Submit multiple circuits in parallel

pub fn circuit_to_qasm<const N: usize>( _circuit: &Circuit<N>, _initial_layout: Option<HashMap<String, usize>>, ) -> DeviceResult<String>

Convert a Quantrs circuit to QASM

Trait Implementations

impl Clone for IBMQuantumClient

Available on crate feature ibm only.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.