Skip to main content

ColdError

Enum ColdError 

Source
#[non_exhaustive]
pub enum ColdError { Io(Error), Seg(SegError), Reopen { file: String, source: SegError, }, CorruptKey, CorruptPayload, }
Expand description

Why sealing entries into a cold segment, or reading them back, failed. The spill is derived data: the caller reports the error and the entries stay rebuildable from the rows.

use kevy_window::ColdError;

assert_eq!(ColdError::CorruptKey.to_string(), "corrupt cold key");

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.
§

Io(Error)

The segment directory could not be created.

let mut w = kevy_window::WindowRt::new(WindowSpec::new("ts", 100, 50), WindowShape::PlainI64);
let mut seg = Segment::new();
seg.apply(b"r:10", None, Some(IndexValue::I64(10)));
seg.apply(b"r:300", None, Some(IndexValue::I64(300)));
let file = dir.path().join("plain-file");
std::fs::write(&file, b"")?;
// a directory cannot be created under a regular file
let e = w.slide(b"t.ts", &mut seg, &file.join("segs")).unwrap_err();
assert!(matches!(e, kevy_window::ColdError::Io(_)));
assert_eq!(seg.stats().entries, 2); // the tree is untouched
§

Seg(SegError)

A segment or the manifest refused.

let mut w = kevy_window::WindowRt::new(WindowSpec::new("ts", 100, 50), WindowShape::PlainI64);
let mut seg = Segment::new();
seg.apply(b"r:10", None, Some(IndexValue::I64(10)));
seg.apply(b"r:300", None, Some(IndexValue::I64(300)));
let file = dir.path().join("plain-file");
std::fs::write(&file, b"")?;
// the segment directory is a regular file, so its manifest will not open
let e = w.slide(b"t.ts", &mut seg, &file).unwrap_err();
assert!(matches!(e, kevy_window::ColdError::Seg(_)));
§

Reopen

The segment just written would not reopen.

use kevy_window::ColdError;
let e = ColdError::Reopen { file: "idx-74-0.seg".into(), source: kevy_seg::SegError::Corrupt("footer") };
assert!(e.to_string().starts_with("reopen idx-74-0.seg: "));
assert!(std::error::Error::source(&e).is_some());

Fields

§file: String

The segment’s file name.

use kevy_window::ColdError;
let e = ColdError::Reopen { file: "idx-74-0.seg".into(), source: kevy_seg::SegError::Corrupt("footer") };
let ColdError::Reopen { file, .. } = &e else { unreachable!() };
assert_eq!(file, "idx-74-0.seg");
§source: SegError

Why it would not reopen.

use kevy_window::ColdError;
let e = ColdError::Reopen { file: "idx-74-0.seg".into(), source: kevy_seg::SegError::Corrupt("footer") };
let ColdError::Reopen { source, .. } = &e else { unreachable!() };
assert!(matches!(source, kevy_seg::SegError::Corrupt("footer")));
§

CorruptKey

A cold key that does not decode.

let e = kevy_window::ColdError::CorruptKey;
assert_eq!(e.to_string(), "corrupt cold key");
assert!(std::error::Error::source(&e).is_none());
§

CorruptPayload

A cold payload that does not decode.

let e = kevy_window::ColdError::CorruptPayload;
assert_eq!(e.to_string(), "corrupt cold payload");

Trait Implementations§

Source§

impl Debug for ColdError

Source§

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

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

impl Display for ColdError

Source§

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

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

impl Error for ColdError

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<SegError> for ColdError

Source§

fn from(e: SegError) -> 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> 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> 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.