Struct Error 

pub struct Error { /* private fields */ }

Error is the main error type for Jetstream

Implementations

impl Error

pub fn message(&self) -> &str

Returns the error message.

pub fn code(&self) -> Option<&str>

Returns the error code, if any.

pub fn help_text(&self) -> Option<&str>

Returns the help text, if any.

pub fn url(&self) -> Option<&str>

Returns the URL, if any.

impl Error

r[impl jetstream.error.v2.span-trace.capture] Construction methods — all paths automatically capture a SpanTrace.

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

Creates a new Error from a message and an optional SpanTrace.

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

Creates a new Error with a message and an error code.

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

Creates an invalid response error with a custom message.

pub fn from_std_error(err: &dyn Error) -> Self

Creates an Error from any std::error::Error type.

impl Error

r[impl jetstream.error.v2.builders] Builder methods for setting optional fields.

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

Sets the error code.

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

Sets the help text.

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

Sets the URL for further documentation.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Diagnostic for Error

Available on crate feature miette only.

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 source_code(&self) -> Option<&dyn SourceCode>

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

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

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

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<!> for Error

fn from(value: Infallible) -> Self

Converts to this type from the input type.

impl From<AddrParseError> for Error

fn from(value: AddrParseError) -> Self

Converts to this type from the input type.

impl From<ClosedStream> for Error

Available on crate feature quinn only.

fn from(value: ClosedStream) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for Error

Available on crate feature quinn only.

fn from(value: ConnectionError) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for Error

Available on crate feature iroh only.

fn from(value: ConnectionError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ReadError> for Error

Available on crate feature quinn only.

fn from(value: ReadError) -> Self

Converts to this type from the input type.

impl From<WriteError> for Error

Available on crate feature quinn only.

fn from(value: WriteError) -> Self

Converts to this type from the input type.

impl WireFormat for Error

r[impl jetstream.error.v2.wireformat] r[impl jetstream.error.v2.wireformat.message] r[impl jetstream.error.v2.wireformat.code] r[impl jetstream.error.v2.wireformat.backtrace]

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.