Struct WithSpan

pub struct WithSpan<E> { /* private fields */ }

Wrapper class for Error, augmenting it with a list of SpanContexts.

Implementations

impl<E> WithSpan<E>

pub const fn new(inner: E) -> Self

Create a new WithSpan from an Error, containing no spans.

pub fn into_inner(self) -> E

Reverse of Self::new, discards span information and returns an inner error.

pub const fn as_inner(&self) -> &E

pub fn spans(&self) -> impl ExactSizeIterator<Item = &SpanContext>

Iterator over stored SpanContexts.

pub fn with_span<S>(self, span: Span, description: S) -> Self

where S: ToString,

Add a new span with description.

pub fn with_context(self, span_context: SpanContext) -> Self

Add a SpanContext.

pub fn into_other<E2>(self) -> WithSpan<E2>

where E2: From<E>,

Convert inner error using From.

pub fn and_then<F, E2>(self, func: F) -> WithSpan<E2>

where F: FnOnce(E) -> WithSpan<E2>,

Convert inner error into another type. Joins span information contained in self with what is returned from func.

pub fn location(&self, source: &str) -> Option<SourceLocation>

Return a SourceLocation for our first span, if we have one.

pub fn emit_to_stderr(&self, source: &str)

where E: Error,

Emits a summary of the error to standard error stream.

pub fn emit_to_stderr_with_path(&self, source: &str, path: &str)

where E: Error,

Emits a summary of the error to standard error stream.

pub fn emit_to_string(&self, source: &str) -> String

where E: Error,

Emits a summary of the error to a string.

pub fn emit_to_string_with_path(&self, source: &str, path: &str) -> String

where E: Error,

Emits a summary of the error to a string.

Trait Implementations

impl<E: Clone> Clone for WithSpan<E>

fn clone(&self) -> WithSpan<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for WithSpan<E>

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

Formats the value using the given formatter.

impl<E> Display for WithSpan<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E> Error for WithSpan<E>

where E: 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<WithSpan<ValidationError>> for PipelineConstantError

fn from(source: WithSpan<ValidationError>) -> Self

Converts to this type from the input type.