Struct InlineError 

pub struct InlineError<const N: usize = 16> { /* private fields */ }

An implementation of Box<dyn std::error::Error> that stores the error payload inline, avoiding dynamic memory allocation. This has several practical drawbacks:

1. The size of the error payload must be at most N bytes.
2. The alignment of the error payload must be at most 8 bytes.

Both of these contraints are verified using post-monomorphization errors.

Example

use diskann_quantization::error::InlineError;

let base_error = u32::try_from(u64::MAX).unwrap_err();
let mut error = InlineError::<8>::new(base_error);
assert_eq!(error.to_string(), base_error.to_string());

// Change the dynamic type of the contained error.
error = InlineError::new(Box::new(base_error));
assert_eq!(error.to_string(), base_error.to_string());

Implementations

impl<const N: usize> InlineError<N>

pub fn new<T>(error: T) -> Self

where T: Error + Send + Sync + 'static,

Construct a new InlineError around error.

Fails to compile if:

1. std::mem::align_of::<T>() > 8: Objects of type T must be compatible with the inline storage buffer.
2. std::mem::size_of::<T>() > N: Objects of type T must fit within a buffer of size N.

Trait Implementations

impl<const N: usize> Debug for InlineError<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for InlineError<N>

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

Formats the value using the given formatter.

impl<const N: usize> Drop for InlineError<N>

fn drop(&mut self)

Executes the destructor for this type.

impl<const N: usize> Error for InlineError<N>

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<const N: usize> Send for InlineError<N>

impl<const N: usize> Sync for InlineError<N>