Struct RemoteFailure

Source

pub struct RemoteFailure { /* private fields */ }

Expand description

An opaque remote failure, including failures inside successful batch or hosted results.

Serialization deliberately exports all retained native evidence, including the bounded body. It is not a redacted logging format. Deserialization rejects invalid categories, inconsistent evidence and values exceeding the documented bounds.

use providers_kit::error::{ErrorKind, NativeErrorDetails, RemoteFailure};
let failure = RemoteFailure::new(ErrorKind::NotFound, NativeErrorDetails::default())?;
assert_eq!(failure.kind(), ErrorKind::NotFound);

Implementations§

Source §

impl RemoteFailure

Source

pub fn new( kind: ErrorKind, details: NativeErrorDetails, ) -> Result<Self, KitError>

Constructs an explicitly classified caller failure without claiming native inference.

Details must already fit 64 KiB per string, 1 MiB total string bytes, and 256 repeated records. Oversized caller evidence is rejected rather than discarded.

§Errors

Returns an input error for local-only categories, invalid numeric/detail fields, or evidence exceeding the documented capture bounds. Explicit classification does not authenticate origin or establish retry safety.

§Examples

use providers_kit::error::{RemoteFailure, NativeErrorDetails, ErrorKind, ClassificationBasis};
let failure = RemoteFailure::new(ErrorKind::NotFound, NativeErrorDetails { message: Some("private detail".into()), ..Default::default() })?;
assert_eq!(failure.kind(), ErrorKind::NotFound);
assert_eq!(failure.classification_basis(), ClassificationBasis::Explicit);
assert_eq!(failure.native_details().message.as_deref(), Some("private detail"));
assert!(!format!("{failure:?}").contains("private detail"));

Source

pub fn kind(&self) -> ErrorKind

Returns the same portable classification vocabulary used by KitError.

§Examples

use providers_kit::error::{RemoteFailure, NativeErrorDetails, ErrorKind, ClassificationBasis};
let failure = RemoteFailure::new(ErrorKind::NotFound, NativeErrorDetails { message: Some("private detail".into()), ..Default::default() })?;
assert_eq!(failure.kind(), ErrorKind::NotFound);
assert_eq!(failure.classification_basis(), ClassificationBasis::Explicit);
assert_eq!(failure.native_details().message.as_deref(), Some("private detail"));
assert!(!format!("{failure:?}").contains("private detail"));

Source

pub fn classification_basis(&self) -> ClassificationBasis

Returns the evidence used for classification, independently of the retained body.

§Examples

use providers_kit::error::{RemoteFailure, NativeErrorDetails, ErrorKind, ClassificationBasis};
let failure = RemoteFailure::new(ErrorKind::NotFound, NativeErrorDetails { message: Some("private detail".into()), ..Default::default() })?;
assert_eq!(failure.kind(), ErrorKind::NotFound);
assert_eq!(failure.classification_basis(), ClassificationBasis::Explicit);
assert_eq!(failure.native_details().message.as_deref(), Some("private detail"));
assert!(!format!("{failure:?}").contains("private detail"));

Source

pub fn native_details(&self) -> &NativeErrorDetails

Explicitly exposes potentially sensitive native evidence.

§Examples

use providers_kit::error::{RemoteFailure, NativeErrorDetails, ErrorKind, ClassificationBasis};
let failure = RemoteFailure::new(ErrorKind::NotFound, NativeErrorDetails { message: Some("private detail".into()), ..Default::default() })?;
assert_eq!(failure.kind(), ErrorKind::NotFound);
assert_eq!(failure.classification_basis(), ClassificationBasis::Explicit);
assert_eq!(failure.native_details().message.as_deref(), Some("private detail"));
assert!(!format!("{failure:?}").contains("private detail"));