Struct Inventory 

pub struct Inventory {
    pub data: BTreeMap<String, BTreeMap<String, InventoryItem>>,
}

In-memory inventory data structure.

BTreeMap, not HashMap, because intersphinx’s case-insensitive std:label/std:term fallback picks the first key that matches case-folded (ext/intersphinx/_resolve.py:104-127) — in Python, dict insertion order, i.e. the order the entries appear in the file. Every inventory Sphinx writes is sorted per objtype (inventory.py:194-196 sorts each domain’s objects), so key order is sorted order there, and a BTreeMap reproduces that choice deterministically instead of leaving it to a hash seed.

Fields

data: BTreeMap<String, BTreeMap<String, InventoryItem>>

Implementations

impl Inventory

pub fn new() -> Self

pub fn insert(&mut self, obj_type: String, name: String, item: InventoryItem)

Insert an item into the inventory

pub fn get(&self, obj_type: &str, name: &str) -> Option<&InventoryItem>

Get an item from the inventory

pub fn contains(&self, obj_type: &str, name: &str) -> bool

Check if an item exists in the inventory

Trait Implementations

impl Clone for Inventory

fn clone(&self) -> Inventory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Inventory

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

Formats the value using the given formatter.

impl Default for Inventory

fn default() -> Inventory

Returns the “default value” for a type.

impl Eq for Inventory

impl PartialEq for Inventory

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Inventory