Enum kekbit::core::ChannelError

pub enum ChannelError {
    InvalidSignature {
        expected: u64,
        actual: u64,
    },
    IncompatibleVersion {
        expected: u64,
        actual: u64,
    },
    InvalidCapacity {
        capacity: u32,
        msg: &'static str,
    },
    InvalidMaxMessageLength {
        msg_len: u32,
        msg: &'static str,
    },
    StorageNotFound {
        file_name: String,
    },
    StorageNotReady {
        file_name: String,
    },
    StorageAlreadyExists {
        file_name: String,
    },
    CouldNotAccessStorage {
        file_name: String,
    },
    MemoryMappingFailed {
        reason: String,
    },
    AccessError {
        reason: String,
    },
}

Channel Access errors

Variants

InvalidSignature

The channel has an invalid signature. The channel signature must be 0x2A54_4942_4B45_4B2A

Fields of InvalidSignature

expected: u64

The expected signature always 0x2A54_4942_4B45_4B2A

actual: u64

The signature red from the kekbit storage

IncompatibleVersion

The channel's storage is of an incompatible file format

Fields of IncompatibleVersion

expected: u64

Expected storage version

actual: u64

Actual storage version

InvalidCapacity

The channel's capacity is invalid. Either too small or is not aligned to 8 bytes.

Fields of InvalidCapacity

capacity: u32

Actual capacity

msg: &'static str

Reason why the capacity is invalid

InvalidMaxMessageLength

The maximum message length specified is invalid

Fields of InvalidMaxMessageLength

msg_len: u32

The specified maximum message length

msg: &'static str

Reason why maximum message length is invalid

StorageNotFound

The channel storage does not exist

Fields of StorageNotFound

file_name: String

The file expected to back the channel storage

StorageNotReady

The channel storage is not ready to access

Fields of StorageNotReady

file_name: String

The file that backs the channel storage

StorageAlreadyExists

The channel storage is not ready to access

Fields of StorageAlreadyExists

file_name: String

The file that backs the channel storage

CouldNotAccessStorage

The channel storage can't be accessed

Fields of CouldNotAccessStorage

file_name: String

The file that backs the channel storage

MemoryMappingFailed

Mapping the channel's file to memory had failed

Fields of MemoryMappingFailed

reason: String

AccessError

Fields of AccessError

reason: String

Trait Implementations

impl Debug for ChannelError

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

Formats the value using the given formatter.

impl Eq for ChannelError

impl Hash for ChannelError

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for ChannelError

fn cmp(&self, other: &ChannelError) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ChannelError> for ChannelError

fn eq(&self, other: &ChannelError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ChannelError) -> bool

This method tests for !=.

impl PartialOrd<ChannelError> for ChannelError

fn partial_cmp(&self, other: &ChannelError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ChannelError) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ChannelError) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ChannelError) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ChannelError) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ChannelError

impl StructuralPartialEq for ChannelError