Struct SurfaceError 

pub struct SurfaceError {
    pub code: String,
    pub message: String,
    pub data: Option<Value>,
    pub retriable: bool,
}

A surfaced failure.

Fields

code: String

The code (filter_invalid, doc_missing, …).

message: String

data: Option<Value>

The data member, when any.

retriable: bool

Implementations

impl SurfaceError

pub fn new(code: &str, message: impl Into<String>) -> Self

pub fn with_data(code: &str, message: impl Into<String>, data: Value) -> Self

pub fn filter_invalid(message: impl Into<String>, hint: &str) -> Self

The reference’s FilterInvalid(reason, hint): filter_invalid with { reason, hint } — the reason is the message itself, the hint the caller’s pointer ("OQX" for an engine error).

pub fn cursor_invalid(surface: &str) -> Self

The reference’s CursorInvalid: a cursor surface did not issue.

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

repo_not_found — also the catch-all (§9).

pub fn to_json(&self) -> Value

The wire envelope.

Trait Implementations

impl Clone for SurfaceError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceError

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

Formats the value using the given formatter.

impl Display for SurfaceError

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

Formats the value using the given formatter.

impl Error for SurfaceError

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

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SurfaceError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SurfaceError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<MutationError> for SurfaceError

fn from(m: MutationError) -> Self

Converts to this type from the input type.

impl From<OqxError> for SurfaceError

fn from(e: OqxError) -> Self

An OQX error is filter_invalid with the engine’s message (§1.4).

impl PartialEq for SurfaceError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SurfaceError