Struct TokmdError 

pub struct TokmdError {
    pub code: ErrorCode,
    pub message: String,
    pub details: Option<String>,
    pub suggestions: Option<Vec<String>>,
}

Structured error for FFI-friendly error reporting.

Fields

code: ErrorCode

Error code for programmatic handling.

message: String

Human-readable error message.

details: Option<String>

Optional additional details.

suggestions: Option<Vec<String>>

Optional helpful suggestions for resolving the error.

Implementations

impl TokmdError

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

Create a new error with given code and message.

pub fn with_details( code: ErrorCode, message: impl Into<String>, details: impl Into<String>, ) -> Self

Create an error with additional details.

pub fn with_suggestions( code: ErrorCode, message: impl Into<String>, suggestions: Vec<String>, ) -> Self

Create an error with suggestions.

pub fn with_details_and_suggestions( code: ErrorCode, message: impl Into<String>, details: impl Into<String>, suggestions: Vec<String>, ) -> Self

Create an error with both details and suggestions.

pub fn git_not_available() -> Self

Create a git not available error.

pub fn not_git_repository(path: &str) -> Self

Create a not git repository error.

pub fn git_operation_failed(operation: &str, reason: &str) -> Self

Create a git operation failed error.

pub fn config_not_found(path: &str) -> Self

Create a config not found error.

pub fn config_invalid(path: &str, reason: &str) -> Self

Create a config invalid error.

pub fn path_not_found_with_suggestions(path: &str) -> Self

Create a path not found error with suggestions.

pub fn path_not_found(path: &str) -> Self

Create a path not found error.

pub fn invalid_json(err: impl Display) -> Self

Create an invalid JSON error.

pub fn unknown_mode(mode: &str) -> Self

Create an unknown mode error.

pub fn scan_error(err: impl Display) -> Self

Create a scan error from an anyhow error.

pub fn analysis_error(err: impl Display) -> Self

Create an analysis error from an anyhow error.

pub fn io_error(err: impl Display) -> Self

Create an I/O error.

pub fn internal(err: impl Display) -> Self

Create an internal error.

pub fn not_implemented(feature: impl Into<String>) -> Self

Create a not implemented error.

pub fn invalid_field(field: &str, expected: &str) -> Self

Create an invalid settings error for a specific field.

pub fn to_json(&self) -> String

Convert to JSON string.

Trait Implementations

impl Clone for TokmdError

fn clone(&self) -> TokmdError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokmdError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokmdError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokmdError

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

Formats the value using the given formatter.

impl Error for TokmdError

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<&TokmdError> for ErrorDetails

fn from(err: &TokmdError) -> Self

Converts to this type from the input type.

impl From<Error> for TokmdError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TokmdError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TokmdError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<TokmdError> for ErrorResponse

fn from(err: TokmdError) -> Self

Converts to this type from the input type.

impl Serialize for TokmdError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.