Struct runefs::Indices

pub struct Indices(_);

A list of valid indices.

Implementations

impl Indices

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

Allocates an Index for every valid index file in the cache directory.

An index is considered valid if it is present. Meaning it will scan the directory for every index id from 0 up to 255 and load them into memory if the file exists. Any invalid indices are simply skipped.

Errors

Constructing this type is quite error prone, it needs to do quite a bit of book-keeping to get its allocation right. However, if the cache is unchanged and in its proper format it will, most likely, succeed.

The primary errors have to do with I/O, in order to read every index successfully it needs a Dat2 reference and the metadata index.

If an index is found it needs to load its entire contents and parse it, failure at this point is considered a bug.

pub fn get(&self, key: &u8) -> Option<&Index>

pub fn count(&self) -> usize

Trait Implementations

impl Clone for Indices

fn clone(&self) -> Indices

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Indices

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

Formats the value using the given formatter.

impl Default for Indices

fn default() -> Indices

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Indices

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

Deserialize this value from the given Serde deserializer.

impl IntoIterator for Indices

type Item = (u8, Index)

The type of the elements being iterated over.

type IntoIter = IntoIter<u8, Index>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Indices

type Item = (&'a u8, &'a Index)

The type of the elements being iterated over.

type IntoIter = Iter<'a, u8, Index>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for Indices

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

Serialize this value into the given Serde serializer.