Struct NitriteError 

pub struct NitriteError { /* private fields */ }

Custom Nitrite error type.

NitriteError encapsulates error information including the error message, kind, and optional cause. It supports error chaining and backtraces for debugging.

Examples

use nitrite::errors::{NitriteError, ErrorKind};

// Create a simple error
let err = NitriteError::new("Index not found", ErrorKind::IndexNotFound);

// Create an error with a cause
let cause = NitriteError::new("IO failed", ErrorKind::IOError);
let err = NitriteError::new_with_cause("Index build failed", ErrorKind::IndexBuildFailed, cause);

Type alias

The NitriteResult<T> type alias is equivalent to Result<T, NitriteError> and is used throughout the codebase for operations that can fail.

Implementations

impl NitriteError

pub fn new(message: &str, error_kind: ErrorKind) -> Self

Creates a new NitriteError with the specified message and error kind.

Arguments

• message - A description of the error
• error_kind - The category of error

Returns

A new NitriteError instance.

pub fn new_with_cause( message: &str, error_type: ErrorKind, cause: NitriteError, ) -> Self

Creates a new NitriteError with a cause error.

This creates an error chain where the cause error is preserved for debugging.

Arguments

• message - A description of the error
• error_type - The category of error
• cause - The underlying error that caused this error

Returns

A new NitriteError instance with the cause error attached.

pub fn message(&self) -> &str

pub fn kind(&self) -> &ErrorKind

pub fn cause(&self) -> Option<&NitriteError>

Trait Implementations

impl Clone for NitriteError

fn clone(&self) -> NitriteError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NitriteError

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

Formats the value using the given formatter.

impl Display for NitriteError

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

Formats the value using the given formatter.

impl Error for NitriteError

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

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl Error for NitriteError

fn custom<T: Display>(msg: T) -> Self

Used when a Serialize implementation encounters any error while serializing a type.

impl From<&str> for NitriteError

fn from(msg: &str) -> Self

Converts to this type from the input type.

impl From<Error> for NitriteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NitriteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for NitriteError

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseFloatError> for NitriteError

fn from(err: ParseFloatError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for NitriteError

fn from(err: ParseIntError) -> Self

Converts to this type from the input type.

impl From<String> for NitriteError

fn from(msg: String) -> Self

Converts to this type from the input type.