Struct OlError 

pub struct OlError {
    pub code: &'static str,
    pub message: String,
    pub suggestion: Option<String>,
    pub docs_url: Option<String>,
}

A structured, user-facing error with an OL-XXXX code.

Display format (D-06/D-07)

Error: {message} (OL-XXXX)

  Suggestion: {actionable text}
  Docs: {url}

Fields

code: &'static str

The OL-XXXX error code (e.g. “OL-1001”).

message: String

Human-readable, actionable error description.

suggestion: Option<String>

Optional suggestion for how to fix the error.

docs_url: Option<String>

Optional link to documentation for this error code.

Implementations

impl OlError

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

Create a new error with the given code and message.

pub fn with_suggestion(self, s: impl Into<String>) -> Self

Attach a suggestion to this error.

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

Attach a docs URL to this error.

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

Build a “bug report” error pre-filled with a GitHub issue URL.

Use this for unexpected internal errors that indicate a bug in openlatch.

Trait Implementations

impl Clone for OlError

fn clone(&self) -> OlError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OlError

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

Formats the value using the given formatter.

impl Display for OlError

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

Formats the value using the given formatter.

impl Error for OlError

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.