Skip to main content

VortexError

Struct VortexError 

Source
pub struct VortexError(/* private fields */);
Expand description

The top-level error type for Vortex.

An error is a message, an optional underlying error, and a backtrace captured at construction. Cloning is cheap: the payload is shared, never copied.

The payload sits behind one pointer, so a VortexResult<T> costs the same as T plus at most a word on the success path. Most results fit in two registers and are returned in them, rather than through a stack slot the caller must reserve and read back. Constructing an error is no more expensive for it: the payload’s allocation is the one the backtrace needed anyway.

Implementations§

Source§

impl VortexError

Source

pub fn new<T: Into<ErrString>>(message: T) -> Self

Creates an error carrying message.

Source

pub fn external<E>(source: E) -> Self
where E: Into<Box<dyn Error + Send + Sync + 'static>>,

Wraps an underlying error as a Vortex error.

The wrapped error is preserved as the Error::source, so callers that care about the concrete type can recover it with Error::source and downcast_ref.

Source

pub fn with_context<T: Into<ErrString>>(self, msg: T) -> Self

Adds additional context to an error, preserving its source and backtrace.

Trait Implementations§

Source§

impl Clone for VortexError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VortexError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for VortexError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for VortexError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<!> for VortexError

Source§

fn from(_: Infallible) -> Self

Converts to this type from the input type.
Source§

impl From<&Arc<VortexError>> for VortexError

Source§

fn from(value: &Arc<VortexError>) -> Self

Converts to this type from the input type.
Source§

impl From<Arc<VortexError>> for VortexError

Source§

fn from(value: Arc<VortexError>) -> Self

Converts to this type from the input type.
Source§

impl From<ArrowError> for VortexError

Source§

fn from(value: ArrowError) -> Self

Converts to this type from the input type.
Source§

impl From<DecodeError> for VortexError

Source§

fn from(value: DecodeError) -> Self

Converts to this type from the input type.
Source§

impl From<EncodeError> for VortexError

Source§

fn from(value: EncodeError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for VortexError

Source§

fn from(value: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for VortexError

Available on crate feature object_store only.
Source§

fn from(value: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for VortexError

Source§

fn from(value: Error) -> Self

Converts to this type from the input type.
Source§

impl From<InvalidFlatbuffer> for VortexError

Available on crate feature flatbuffers only.
Source§

fn from(value: InvalidFlatbuffer) -> Self

Converts to this type from the input type.
Source§

impl From<JoinError> for VortexError

Available on crate feature tokio only.
Source§

fn from(value: JoinError) -> Self

Converts to this type from the input type.
Source§

impl From<TryFromIntError> for VortexError

Source§

fn from(value: TryFromIntError) -> Self

Converts to this type from the input type.
Source§

impl From<UnknownEnumValue> for VortexError

Source§

fn from(value: UnknownEnumValue) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.