Struct Error 

pub struct Error(/* private fields */);

A small container retaining the typed error from a Bloq workflow.

Subsystem APIs keep their concrete errors. In a function returning Result, ? wraps those errors automatically. Use Self::downcast_ref to inspect the original error and StdError::source to traverse its causes. Application-specific errors can be wrapped with Self::new.

use bloq::prelude::*;

fn circuit_text(source: &str) -> Result<String> {
    let graph = parse_blog_to_graph(source)?;
    let config = CompileConfig::try_new(3)?;
    let artifacts = compile_with(&graph, config)?;
    Ok(emit_bloq_stim(&artifacts.bloq)?)
}

let error = circuit_text("invalid BLOG").unwrap_err();
assert!(error.is::<bloq::graph::BlockGraphError>());

Implementations

impl Error

pub fn new(error: impl StdError + Send + Sync + 'static) -> Self

Wrap an owned error, retaining its type, message, and causes.

let error = bloq::Error::new("invalid".parse::<u32>().unwrap_err());
assert!(error.is::<std::num::ParseIntError>());

pub fn is<E: StdError + 'static>(&self) -> bool

Whether the original error has type E.

pub fn downcast_ref<E: StdError + 'static>(&self) -> Option<&E>

Borrow the original error if it has type E.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BinaryDecodeError> for Error

fn from(error: BinaryDecodeError) -> Self

Converts to this type from the input type.

impl From<BlockError> for Error

fn from(error: BlockError) -> Self

Converts to this type from the input type.

impl From<BlockGraphError> for Error

fn from(error: BlockGraphError) -> Self

Converts to this type from the input type.

impl From<BloqStatsError> for Error

fn from(error: BloqStatsError) -> Self

Converts to this type from the input type.

impl From<BloqValidationError> for Error

fn from(error: BloqValidationError) -> Self

Converts to this type from the input type.

impl From<BooleanResourceError> for Error

fn from(error: BooleanResourceError) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for Error

fn from(error: Box<dyn StdError + Send + Sync + 'static>) -> Self

Converts to this type from the input type.

impl From<CircuitError> for Error

fn from(error: CircuitError) -> Self

Converts to this type from the input type.

impl From<CompileError> for Error

fn from(error: CompileError) -> Self

Converts to this type from the input type.

impl From<CoordinateOverflowError> for Error

fn from(error: CoordinateOverflowError) -> Self

Converts to this type from the input type.

impl From<CycleDetected> for Error

fn from(error: CycleDetected) -> Self

Converts to this type from the input type.

impl From<DecoderError> for Error

Available on crate feature vm only.

fn from(error: DecoderError) -> Self

Converts to this type from the input type.

impl From<DetectorBundleError> for Error

fn from(error: DetectorBundleError) -> Self

Converts to this type from the input type.

impl From<DetsliceError> for Error

fn from(error: DetsliceError) -> Self

Converts to this type from the input type.

impl From<DirectionParseError> for Error

fn from(error: DirectionParseError) -> Self

Converts to this type from the input type.

impl From<EditError> for Error

fn from(error: EditError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature vm only.

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ExecError> for Error

Available on crate feature vm only.

fn from(error: ExecError) -> Self

Converts to this type from the input type.

impl From<FeedbackInferenceError> for Error

Available on crate feature graph-verify only.

fn from(error: FeedbackInferenceError) -> Self

Converts to this type from the input type.

impl From<FillPortsError> for Error

fn from(error: FillPortsError) -> Self

Converts to this type from the input type.

impl From<FlattenError> for Error

fn from(error: FlattenError) -> Self

Converts to this type from the input type.

impl From<FlowError> for Error

fn from(error: FlowError) -> Self

Converts to this type from the input type.

impl From<InvalidActionError> for Error

fn from(error: InvalidActionError) -> Self

Converts to this type from the input type.

impl From<InvalidBlockGraphError> for Error

fn from(error: InvalidBlockGraphError) -> Self

Converts to this type from the input type.

impl From<InvalidDistance> for Error

fn from(error: InvalidDistance) -> Self

Converts to this type from the input type.

impl From<LowerError> for Error

Available on crate feature vm only.

fn from(error: LowerError) -> Self

Converts to this type from the input type.

impl From<MeasurementFrameError> for Error

fn from(error: MeasurementFrameError) -> Self

Converts to this type from the input type.

impl From<MembershipPinError> for Error

fn from(error: MembershipPinError) -> Self

Converts to this type from the input type.

impl From<ModuleCertificationError> for Error

fn from(error: ModuleCertificationError) -> Self

Converts to this type from the input type.

impl From<ModuleError> for Error

fn from(error: ModuleError) -> Self

Converts to this type from the input type.

impl From<MomentAlignmentError> for Error

fn from(error: MomentAlignmentError) -> Self

Converts to this type from the input type.

impl From<OutputCorrectionError> for Error

fn from(error: OutputCorrectionError) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(error: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(error: ParseError) -> Self

Converts to this type from the input type.

impl From<PauliError> for Error

fn from(error: PauliError) -> Self

Converts to this type from the input type.

impl From<ProgramSliceError> for Error

fn from(error: ProgramSliceError) -> Self

Converts to this type from the input type.

impl From<QasmError> for Error

fn from(error: QasmError) -> Self

Converts to this type from the input type.

impl From<ResolveDomainError> for Error

fn from(error: ResolveDomainError) -> Self

Converts to this type from the input type.

impl From<ResolveError> for Error

fn from(error: ResolveError) -> Self

Converts to this type from the input type.

impl From<RuntimeBasisError> for Error

fn from(error: RuntimeBasisError) -> Self

Converts to this type from the input type.

impl From<RuntimeError> for Error

Available on crate feature vm only.

fn from(error: RuntimeError) -> Self

Converts to this type from the input type.

impl From<SimError> for Error

Available on crate feature vm only.

fn from(error: SimError) -> Self

Converts to this type from the input type.

impl From<StabilizerError> for Error

fn from(error: StabilizerError) -> Self

Converts to this type from the input type.

impl From<StimEmissionError> for Error

fn from(error: StimEmissionError) -> Self

Converts to this type from the input type.

impl From<StimNoiseError> for Error

Available on crate feature verify only.

fn from(error: StimNoiseError) -> Self

Converts to this type from the input type.

impl From<StimVerifyError> for Error

Available on crate feature verify only.

fn from(error: StimVerifyError) -> Self

Converts to this type from the input type.

impl From<StructureError> for Error

fn from(error: StructureError) -> Self

Converts to this type from the input type.

impl From<SymbolicBasisError> for Error

fn from(error: SymbolicBasisError) -> Self

Converts to this type from the input type.

impl From<TextParseError> for Error

fn from(error: TextParseError) -> Self

Converts to this type from the input type.

impl From<UnknownCertificationLimit> for Error

fn from(error: UnknownCertificationLimit) -> Self

Converts to this type from the input type.

impl From<VerifyLogicalError> for Error

Available on crate feature graph-verify only.

fn from(error: VerifyLogicalError) -> Self

Converts to this type from the input type.

impl From<ZXError> for Error

fn from(error: ZXError) -> Self

Converts to this type from the input type.