Enum CodecError 

pub enum CodecError {
    Wire(DecodeError),
    Bitstream(BitError),
    OutputTooSmall {
        needed: usize,
        available: usize,
    },
    SchemaMismatch {
        expected: u64,
        found: u64,
    },
    LimitsExceeded {
        kind: LimitKind,
        limit: usize,
        actual: usize,
    },
    InvalidMask {
        kind: MaskKind,
        reason: MaskReason,
    },
    InvalidValue {
        component: ComponentId,
        field: FieldId,
        reason: ValueReason,
    },
    InvalidEntityOrder {
        previous: u32,
        current: u32,
    },
    TrailingSectionData {
        section: SectionTag,
        remaining_bits: usize,
    },
    UnexpectedSection {
        section: SectionTag,
    },
    DuplicateSection {
        section: SectionTag,
    },
    DuplicateUpdateEncoding,
    BaselineTickMismatch {
        expected: u32,
        found: u32,
    },
    BaselineNotFound {
        requested_tick: u32,
    },
    EntityNotFound {
        entity_id: u32,
    },
    ComponentNotFound {
        entity_id: u32,
        component_id: u16,
    },
    DuplicateEntity {
        entity_id: u32,
    },
    EntityAlreadyExists {
        entity_id: u32,
    },
    SessionMissing,
    SessionInitInvalid,
    SessionUnsupportedMode {
        mode: u8,
    },
    SessionOutOfOrder {
        previous: u32,
        current: u32,
    },
}

Errors that can occur during snapshot/delta encoding/decoding.

Variants

Wire(DecodeError)

Wire format error.

Bitstream(BitError)

Bitstream error.

OutputTooSmall

Output buffer is too small.

Fields

needed: usize

available: usize

SchemaMismatch

Schema hash mismatch.

Fields

expected: u64

found: u64

LimitsExceeded

Limits exceeded.

Fields

kind: LimitKind

limit: usize

actual: usize

InvalidMask

Invalid mask data.

Fields

kind: MaskKind

reason: MaskReason

InvalidValue

Invalid field value for the schema.

Fields

component: ComponentId

field: FieldId

reason: ValueReason

InvalidEntityOrder

Entities are not provided in deterministic order.

Fields

previous: u32

current: u32

TrailingSectionData

Section body had trailing bits after parsing.

Fields

section: SectionTag

remaining_bits: usize

UnexpectedSection

Unexpected section for the current packet type.

Fields

section: SectionTag

DuplicateSection

Duplicate section encountered.

Fields

section: SectionTag

DuplicateUpdateEncoding

Multiple update encodings present in one packet.

BaselineTickMismatch

Baseline tick does not match the packet.

Fields

expected: u32

found: u32

BaselineNotFound

Baseline tick not found in history.

Fields

requested_tick: u32

The requested baseline tick.

EntityNotFound

Entity not found when applying delta.

Fields

entity_id: u32

The missing entity ID.

ComponentNotFound

Component not found when applying delta.

Fields

entity_id: u32

The entity ID.

component_id: u16

The missing component ID.

DuplicateEntity

Duplicate entity in create section.

Fields

entity_id: u32

The duplicate entity ID.

EntityAlreadyExists

Entity already exists when creating.

Fields

entity_id: u32

The existing entity ID.

SessionMissing

Missing session state for compact packets.

SessionInitInvalid

Session init packet was invalid.

SessionUnsupportedMode

Session compact header mode is unsupported.

Fields

mode: u8

SessionOutOfOrder

Session packets arrived out of order.

Fields

previous: u32

current: u32

Implementations

impl CodecError

pub fn needs_resync(&self) -> bool

Returns true if the error indicates the client should resync via a session init + full snapshot.

Trait Implementations

impl Clone for CodecError

fn clone(&self) -> CodecError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecError

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

Formats the value using the given formatter.

impl Display for CodecError

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

Formats the value using the given formatter.

impl Eq for CodecError

impl Error for CodecError

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 From<BitError> for CodecError

fn from(err: BitError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for CodecError

fn from(err: DecodeError) -> Self

Converts to this type from the input type.

impl PartialEq for CodecError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CodecError