Struct ResourceIndex 

pub struct ResourceIndex<'a> { /* private fields */ }

A parsed resources.index, borrowing the bytes it was read from.

use asc_hap::{ResourceIndex, ResourceRef, ResourceType};

let index = ResourceIndex::parse(bytes)?;
// `$r('app.string.app_name')` compiled to `{ id: 0x1000000, type: 10003, .. }`.
for resource in index.by_id(0x0100_0000) {
    println!("{resource}"); // 0x01000000 string/app_name [base] "Bridge"
}
// `"label": "$string:app_name"` in module.json.
let label = ResourceRef::parse("$string:app_name").expect("a reference");
assert!(index.resolve(label).all(|r| r.kind() == ResourceType::String));

Implementations

impl<'a> ResourceIndex<'a>

pub fn parse(bytes: &'a [u8]) -> Result<ResourceIndex<'a>, ResourceIndexError>

Reads the tables of an index. Values are not decoded here.

Errors

ResourceIndexError::UnknownVersion when the header names neither layout; the other variants when a table is cut short, points outside the file or contradicts another.

pub fn version(&self) -> &str

The version text of the header: Restool 5.0.1.011.

pub fn format(&self) -> IndexFormat

Which of the two layouts the file uses.

pub fn qualifiers(&self) -> &[Qualifiers]

The qualifier sets the index defines, in file order.

pub fn len(&self) -> usize

Number of values: one per resource and qualifier set.

pub fn is_empty(&self) -> bool

Whether the index holds no values at all.

pub fn iter(&self) -> Resources<'_>

Every value, by id and then by qualifier set in file order.

pub fn by_id(&self, id: u32) -> Resources<'_>

The values of the resource with this id, one per qualifier set. The id is the id of a compiled $r(...) object and the labelId / iconId / descriptionId of module.json.

pub fn by_name(&self, kind: ResourceType, name: &str) -> Resources<'_>

The values of the resource with this type and name.

pub fn resolve(&self, reference: ResourceRef<'_>) -> Resources<'_>

The values a reference points at: by name, or, for the decimal ids that values inside the index use ($color:16777245), by id among the resources of that type. A name wins over an id spelled alike.

Trait Implementations

impl<'a> Clone for ResourceIndex<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ResourceIndex<'a>

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

Formats the value using the given formatter.

impl<'r> IntoIterator for &'r ResourceIndex<'_>

type Item = Resource<'r>

The type of the elements being iterated over.

type IntoIter = Resources<'r>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Resources<'r>

Creates an iterator from a value.