feat: #554: Riverlane translation options (#553)

* feat: Riverlane translation options

* for now, ignore PyO3 issue

* add the Python & typestubs

* warn, not error, on large return err variants

* manually fix clippy style issues

Author: BatmanAoD

Cargo.lock

@@ -3,9 +3,9 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.dependencies]
-qcs-api-client-common = "0.12.0"
-qcs-api-client-grpc = "0.12.0"
-qcs-api-client-openapi = "0.13.0"
+qcs-api-client-common = "0.12.5"
+qcs-api-client-grpc = "0.12.5"
+qcs-api-client-openapi = "0.13.5"
 serde_json = "1.0.86"
 thiserror = "1.0.57"
 tokio = "1.36.0"

Cargo.toml

@@ -42,15 +42,15 @@ impl Qubit {
     ///
     /// # Arguments
     /// 1. `op_name`: The name of the operation defined on this Qubit. This comes from
-    ///     `instructions[n].name` in the QCS response.
+    ///    `instructions[n].name` in the QCS response.
     /// 2. `characteristics`: Data related to the operation at a this site (Qubit). Comes from
-    ///     `instructions[n].sites[m].characteristics` in the QCS response.
+    ///    `instructions[n].sites[m].characteristics` in the QCS response.
     /// 3. `benchmarks`: Top level benchmarks on the Qubits, comes from `benchmarks` in the QCS
-    ///     response.
+    ///    response.
     ///
     /// # Errors
     /// 1. `randomized_benchmark_simultaneous_1q` was not present in `benchmarks`: this is necessary
-    ///     for RX and RZ gates.
+    ///    for RX and RZ gates.
     /// 2. An unknown `op_name` was provided.
     pub(crate) fn add_operation(
         &mut self,

crates/lib/src/compiler/isa/qubit.rs

@@ -113,7 +113,7 @@ impl<'executable> Executable<'executable, '_> {
     /// # Arguments
     ///
     /// 1. `quil` is a string slice representing the original program to be run. The returned
-    ///     [`Executable`] will only live as long as this reference.
+    ///    [`Executable`] will only live as long as this reference.
     #[must_use]
     #[allow(clippy::missing_panics_doc)]
     pub fn from_quil<Quil: Into<Arc<str>>>(quil: Quil) -> Self {
@@ -138,8 +138,8 @@ impl<'executable> Executable<'executable, '_> {
     /// # Arguments
     ///
     /// 1. `register` is a string reference of the name of a register to read from. The lifetime
-    ///     of this reference should be the lifetime of the [`Executable`], which is the lifetime of
-    ///     the `quil` argument to [`Executable::from_quil`].
+    ///    of this reference should be the lifetime of the [`Executable`], which is the lifetime of
+    ///    the `quil` argument to [`Executable::from_quil`].
     ///
     /// # Example
     ///
@@ -212,8 +212,8 @@ impl<'executable> Executable<'executable, '_> {
     /// # Arguments
     ///
     /// 1. `param_name`: Reference to the name of the parameter which should correspond to a
-    ///     `DECLARE` statement in the Quil program. The lifetime of the reference should be the
-    ///     same as the [`Executable`]: that is the same as the `quil` param to [`Executable::from_quil`].
+    ///    `DECLARE` statement in the Quil program. The lifetime of the reference should be the
+    ///    same as the [`Executable`]: that is the same as the `quil` param to [`Executable::from_quil`].
     /// 2. `index`: The index into the memory vector that you're setting.
     /// 3. `value`: The value to set for the specified memory.
     ///
@@ -424,8 +424,8 @@ impl<'execution> Executable<'_, 'execution> {
     ///
     /// # Arguments
     /// 1. `quantum_processor_id`: The name of the QPU to run on. This parameter affects the
-    ///     lifetime of the [`Executable`]. The [`Executable`] will only live as long as the last
-    ///     parameter passed into this function.
+    ///    lifetime of the [`Executable`]. The [`Executable`] will only live as long as the last
+    ///    parameter passed into this function.
     ///
     /// # Warning
     ///
@@ -465,13 +465,13 @@ impl<'execution> Executable<'_, 'execution> {
     ///
     /// # Arguments
     /// 1. `quantum_processor_id`: The ID of the QPU for which to translate the program.
-    ///     This parameter affects the lifetime of the [`Executable`].
-    ///     The [`Executable`] will only live as long as the last parameter passed into this function.
+    ///    This parameter affects the lifetime of the [`Executable`].
+    ///    The [`Executable`] will only live as long as the last parameter passed into this function.
     /// 2. `translation_options`: An optional [`TranslationOptions`] that is used to configure how
     ///    the program in translated.
     /// 3. `execution_options`: The [`ExecutionOptions`] to use. If the connection strategy used
-    ///       is [`crate::qpu::api::ConnectionStrategy::EndpointId`] then direct access to that endpoint
-    ///       overrides the `quantum_processor_id` parameter.
+    ///    is [`crate::qpu::api::ConnectionStrategy::EndpointId`] then direct access to that endpoint
+    ///    overrides the `quantum_processor_id` parameter.
     ///
     /// # Warning
     ///
@@ -523,13 +523,13 @@ impl<'execution> Executable<'_, 'execution> {
     ///
     /// # Arguments
     /// 1. `quantum_processor_id`: The ID of the QPU for which to translate the program.
-    ///     This parameter affects the lifetime of the [`Executable`].
-    ///     The [`Executable`] will only live as long as the last parameter passed into this function.
+    ///    This parameter affects the lifetime of the [`Executable`].
+    ///    The [`Executable`] will only live as long as the last parameter passed into this function.
     /// 2. `translation_options`: An optional [`TranslationOptions`] that is used to configure how
     ///    the program in translated.
     /// 3. `execution_options`: The [`ExecutionOptions`] to use. If the connection strategy used
-    ///       is [`crate::qpu::api::ConnectionStrategy::EndpointId`] then direct access to that endpoint
-    ///       overrides the `quantum_processor_id` parameter.
+    ///    is [`crate::qpu::api::ConnectionStrategy::EndpointId`] then direct access to that endpoint
+    ///    overrides the `quantum_processor_id` parameter.
     ///
     /// # Errors
     ///

crates/lib/src/executable.rs

@@ -4,6 +4,8 @@
 #![allow(clippy::missing_errors_doc)]
 #![allow(clippy::implicit_hasher)]
 #![allow(clippy::too_many_arguments)]
+#![warn(clippy::result_large_err)] // TODO #555: box the large variants or change the lint threshold
+#![warn(clippy::large_enum_variant)] // TODO #555: box the large variants
 #![forbid(unsafe_code)]
 #![warn(future_incompatible)]
 #![warn(rust_2018_compatibility, rust_2018_idioms)]