Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 16 variants Unknown, NoResult, ConnectionFailed, PathConflict { active: String, requested: String, }, InvalidData(String), PathError, Io(Error), Nul(NulError), InsufficientPermissions, NonUtf8Sequence(FromUtf8Error), InvalidUtf8(Utf8Error), EngineVersionUnavailable, EngineCallFailed { call: &'static str, }, QueryError(String), ConnectionsStillOpen { count: usize, }, EngineShutDown,
}
Expand description

Errors that can occur when using chdb-rust.

This enum represents all possible errors that can be returned by the library. Most errors are self-explanatory, with QueryError containing the actual error message from the underlying chDB library.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Unknown

An unknown error has occurred.

§

NoResult

No result was returned from the query.

§

ConnectionFailed

Failed to establish a connection to chDB.

§

PathConflict

The engine is already bound to a different data path.

One engine per process serves one storage path. An in-memory connection counts as a path of its own, since the engine binds :memory: when none is given.

Fields

§active: String

The path the engine is bound to.

§requested: String

The path that was asked for.

§

InvalidData(String)

Invalid data was encountered.

§

PathError

Invalid path was provided.

§

Io(Error)

An I/O error occurred.

§

Nul(NulError)

A null byte was found in a string where it’s not allowed.

§

InsufficientPermissions

Insufficient permissions to access the directory.

§

NonUtf8Sequence(FromUtf8Error)

The data contains invalid UTF-8 sequences.

§

InvalidUtf8(Utf8Error)

The result data is not valid UTF-8.

Returned by QueryResult::data_str, which checks the bytes in place rather than copying them first.

§

EngineVersionUnavailable

The linked library cannot report which chdb-core release it is.

chdb_version() arrived in chdb-core v26.7.0; an older library does not export it, so there is nothing to call. Deliberately not answered with SELECT version(), which reports a ClickHouse version — a different scheme, and so not a substitute.

§

EngineCallFailed

A chDB call reported failure without saying why.

call names the C function, so the two cases this covers — a shutdown that could not stop every engine thread, and an insert-stream append that failed with no error recorded on the stream — can be told apart.

Fields

§call: &'static str

The chDB C function that failed.

§

QueryError(String)

A query execution error occurred.

This contains the error message from the underlying chDB library, which typically includes details about SQL syntax errors, missing tables, etc.

§

ConnectionsStillOpen

Shutdown was asked for while connections were still open.

The engine refuses this rather than tearing itself down under a live connection. Close every connection and drop every result first.

Fields

§count: usize

How many connection handles are still holding the engine.

§

EngineShutDown

The engine was shut down earlier in this process.

runtime::shutdown is one-way: once it succeeds the library is closed for business for the rest of the process.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

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

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<NulError> for Error

Source§

fn from(source: NulError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Forget for Error

§

impl Freeze for Error

§

impl Move for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.