Struct Error 

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

Error represents a collection of errors that occurred during a Jetstream operation.

Implementations

impl Error

pub fn into_inner(self) -> MietteDiagnostic

Gets the inner miette::MietteDiagnostic.

impl Error

Common error constants for RPC operations.

pub const InvalidResponse: Error

Error returned when an invalid response is received.

pub fn new(message: impl Into<String>) -> Self

Creates a new Error from a string.

pub fn invalid_response(message: impl Into<String>) -> Self

Creates an invalid response error with a custom message.

pub fn from_diagnostic<D: Diagnostic + Display>(value: D) -> Self

Creates an Error from a Diagnostic type.

impl Error

pub fn with_code(self, code: impl Into<String>) -> Self

Creates an Error with a custom code.

pub fn with_severity(self, severity: Severity) -> Self

Creates an Error with a custom severity.

pub fn with_help(self, help: impl Into<String>) -> Self

Creates an Error with a custom help message.

pub fn with_url(self, url: impl Into<String>) -> Self

Creates an Error with a custom URL.

pub fn with_labels(self, labels: impl IntoIterator<Item = LabeledSpan>) -> Self

Adds labels to the error.

pub fn with_label(self, label: LabeledSpan) -> Self

Adds a label to the error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Deref for Error

type Target = MietteDiagnostic

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Diagnostic for Error

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for Error

fn fmt(&self, f: &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<AddrParseError> for Error

fn from(value: AddrParseError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for MietteDiagnostic

fn from(val: Error) -> Self

Converts to this type from the input type.

impl From<Infallible> for Error

fn from(value: Infallible) -> Self

Converts to this type from the input type.

impl From<MietteDiagnostic> for Error

fn from(value: MietteDiagnostic) -> Self

Converts to this type from the input type.

impl WireFormat for Error

fn byte_size(&self) -> u32

Returns the number of bytes necessary to fully encode self.

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

where Self: Sized,

Encodes self into writer.

fn decode<R: Read>(reader: &mut R) -> Result<Self>

where Self: Sized,

Decodes Self from reader.