Struct ArchiveRef

pub struct ArchiveRef {
    pub id: u32,
    pub index_id: u8,
    pub sector: usize,
    pub length: usize,
}

A reference to an archive segment.

Archives are not stored in a contiguous fashion. An ArchiveRef is basically a wide pointer, like &str or &[u8]. When an Archive is fetched from the Dat2 file it knows where the memory starts and its length. Each block of memory belong to the archive is viewed as a Sector, which contains a pointer to the next sector. Once this chain is exhausted you are left with all of the archive data.

Fields

id: u32

index_id: u8

sector: usize

length: usize

Implementations

impl ArchiveRef

pub fn from_buffer(id: u32, index_id: u8, buffer: &[u8]) -> Result<Self, Error>

Transforms an Index sub-buffer into an archive reference.

Errors

Will fail if the buffer is not exactly 6 bytes in length.

pub fn data_blocks(&self) -> DataBlocks

Generate a data block iterator from this archive reference.

Trait Implementations

impl Clone for ArchiveRef

fn clone(&self) -> ArchiveRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveRef

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

Formats the value using the given formatter.

impl Default for ArchiveRef

fn default() -> ArchiveRef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArchiveRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ArchiveRef> for SectorHeaderSize

fn from(archive: &ArchiveRef) -> Self

Converts to this type from the input type.

impl Hash for ArchiveRef

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ArchiveRef

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ArchiveRef

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

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

const 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 PartialOrd for ArchiveRef

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ArchiveRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ArchiveRef

impl Eq for ArchiveRef

impl StructuralPartialEq for ArchiveRef