Struct StructError

Source

pub struct StructError<T: DomainReason> { /* private fields */ }

Expand description

Structured runtime error carrier with explicit bridge APIs for the standard error ecosystem.

use orion_error::{StructError, UvsReason};

let err = StructError::from(UvsReason::system_error());
let _ = std::error::Error::source(&err);

use orion_error::{StructError, UvsReason};

let err = StructError::from(UvsReason::system_error());
let bridged = err.as_std();
let _ = std::error::Error::source(&bridged);

Implementations§

Source §

pub fn new( reason: T, detail: Option<String>, position: Option<String>, context: Vec<OperationContext>, ) -> Self

Source §

impl<T: DomainReason> StructError<T>

Source

pub fn attach_source<S>(self, source: S) -> Self
where S: IntoSourcePayload,

Attach any source that can be converted into the dual-channel source payload model.

Ordinary StdError values attach as SourcePayloadKind::Std, while StructError<_> attaches as SourcePayloadKind::Struct.

Source

pub fn with_source<S>(self, source: S) -> Self
where S: IntoSourcePayload,

Auto-route a source error through the dual-channel source model.

This is the recommended public entry point for attaching sources. It accepts both standard StdError values and StructError<_> values, automatically routing through the correct internal channel via the IntoSourcePayload trait.

For call sites that need to explicitly choose the source kind, use attach_source instead.

Source

pub fn source_ref(&self) -> Option<&(dyn StdError + 'static)>

Source

pub fn root_cause(&self) -> Option<&(dyn StdError + 'static)>

Source

pub fn source_frames(&self) -> &[SourceFrame]

Source

pub fn source_payload(&self) -> Option<SourcePayloadRef<'_>>

Source

pub fn source_payload_kind(&self) -> Option<SourcePayloadKind>

Source

pub fn root_cause_frame(&self) -> Option<&SourceFrame>

Source

pub fn context_metadata(&self) -> ErrorMetadata

Returns merged metadata from all context layers.

Context layers are iterated in push order (innermost first). The merge uses an inner wins strategy: the first value set for any key is kept; outer layers only supply keys that are missing from inner layers.

For example, if inner context sets key = "inner" and outer context sets key = "outer", the result is key = "inner".

To query metadata from a specific context layer, use [context_metadata_at].

Source

pub fn context_metadata_at(&self, index: usize) -> Option<&ErrorMetadata>

Returns the metadata from a specific context layer by index.

Index 0 is the innermost (first pushed) context layer. Returns None if the index is out of bounds.

Source

pub fn source_chain(&self) -> Vec<String>

Source

pub fn into_std(self) -> OwnedStdStructError<T>

Source

pub fn into_boxed_std(self) -> Box<dyn StdError + Send + Sync + 'static>

Source

pub fn into_dyn_std(self) -> OwnedDynStdStructError
where T: DomainReason,

Source

pub fn as_std(&self) -> StdStructRef<'_, T>

Source

pub fn display_chain(&self) -> String
where T: Debug + Display + 'static,

Source §

impl<T: DomainReason> StructError<T>

Source

pub fn builder(reason: T) -> StructErrorBuilder<T>

Source

pub fn with_position(self, position: impl Into<String>) -> Self

使用示例 self.with_position(location!());

Source

pub fn with_context<C: Into<OperationContext>>(self, context: C) -> Self

Source

pub fn contexts(&self) -> &[OperationContext]

Source

pub fn with_detail(self, detail: impl Into<String>) -> Self

Source

pub fn err<V>(self) -> Result<V, Self>

Source

pub fn target_main(&self) -> Option<String>

Source

pub fn action_main(&self) -> Option<String>

Source

pub fn locator_main(&self) -> Option<String>

Source

pub fn target(&self) -> Option<String>

Compatibility alias for target_main().

Prefer target_main() in new code when pairing it with target_path().

Source

pub fn path_segments(&self) -> Vec<String>

Source

pub fn target_path(&self) -> Option<String>

Source §

impl<T: DomainReason> StructError<T>

Source

pub fn report(&self) -> DiagnosticReport

Build a DiagnosticReport from this error.

The report carries human-readable reason, detail, context, and source frames — no identity or protocol data.

§Example

use orion_error::{StructError, UvsReason};
use orion_error::report::DiagnosticReport;

let err = StructError::from(UvsReason::validation_error())
    .with_detail("field `email` is required");

let report: DiagnosticReport = err.report();
assert!(report.reason.contains("validation"));
assert_eq!(report.detail.as_deref(), Some("field `email` is required"));

Source

pub fn into_report(self) -> DiagnosticReport

Source

pub fn report_redacted(&self, policy: &impl RedactPolicy) -> DiagnosticReport

Source

pub fn render(&self) -> String

Render this error as a human-readable diagnostic string.

Delegates to DiagnosticReport::render().

§Example

use orion_error::StructError;
use orion_error::reason::UvsReason;

let s = StructError::from(UvsReason::validation_error())
    .with_detail("field `email` is required")
    .render();
assert!(s.contains("validation"));
assert!(s.contains("field `email` is required"));

Source

pub fn render_redacted(&self, policy: &impl RedactPolicy) -> String

Source §

impl<T: DomainReason + ErrorIdentityProvider> StructError<T>

Source

pub fn exposure_snapshot( &self, exposure_policy: &impl ExposurePolicy, ) -> ErrorProtocolSnapshot

Build an ErrorProtocolSnapshot by combining identity, exposure decision, and diagnostic report in one pass.

This is the primary entry point for protocol-level error output. Requires ErrorIdentityProvider (provided by #[derive(OrionError)]).

§Example

use orion_error::{DefaultExposurePolicy, StructError, UvsReason};

let err = StructError::from(UvsReason::system_error())
    .with_detail("disk full");
let proto = err.exposure_snapshot(&DefaultExposurePolicy);
assert_eq!(proto.identity.code, "sys.io_error");
assert_eq!(proto.decision.http_status, 500);

Source