Struct runefs::Index

pub struct Index {
    pub id: u8,
    pub archive_refs: HashMap<u32, ArchiveRef>,
    pub metadata: IndexMetadata,
}

A virtual file type for every .idx in the cache directory.

Fields

id: u8

archive_refs: HashMap<u32, ArchiveRef>

metadata: IndexMetadata

Implementations

impl Index

pub fn from_path<P: AsRef<Path>>(id: u8, path: P) -> Result<Self, Error>

Creates an Index from a file path.

Panics

When an index is loaded the given id and its file extension are compared, if these mismatch it is considered a bug.

Errors

The primary errors concern I/O where the file couldn’t be opened or read.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Index

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

Serialize this value into the given Serde serializer.