Struct rscache::sec::SectorHeader

pub struct SectorHeader {
    pub archive_id: u32,
    pub chunk: u16,
    pub next: u32,
    pub index_id: u8,
}

Contains the sector header for reading the next sector and validating the current sector.

Fields

archive_id: u32

chunk: u16

next: u32

index_id: u8

Implementations

impl SectorHeader

pub fn new(buffer: &[u8], expanded_header: bool) -> Result<(&[u8], Self)>

Decodes only the header data from the buffer leaving the data block untouched.

The expanded header should be 10 bytes instead of the usual 8 bytes.

pub fn validate(
    &self,
    archive_id: u32,
    chunk: u16,
    index_id: u8
) -> Result<(), ReadError>

Validates the current archive_id, chunk and index_id against the expected values from this header struct.

Trait Implementations

impl Clone for SectorHeader

fn clone(&self) -> SectorHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SectorHeader

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

Formats the value using the given formatter.

impl Default for SectorHeader

fn default() -> SectorHeader

Returns the "default value" for a type.

impl Eq for SectorHeader

impl Hash for SectorHeader

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

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 SectorHeader

fn cmp(&self, other: &SectorHeader) -> 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<SectorHeader> for SectorHeader

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

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

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

This method tests for !=.

impl PartialOrd<SectorHeader> for SectorHeader

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for SectorHeader

impl StructuralPartialEq for SectorHeader