Enum ItemLoader

pub(crate) enum ItemLoader {
    Normal(GameFlags, Item, fn(_: &mut Db, _: Token, _: Block)),
    Full(GameFlags, Item, PdxEncoding, &'static str, bool, fn(_: &mut Db, _: Token, _: Block)),
}

The specification for loading an Item type into the Db.

An instance of this can be placed in every data module using the inventory::collect! macro. This will register the loader so that the Everything object can load all defined items.

Variants

Normal(GameFlags, Item, fn(_: &mut Db, _: Token, _: Block))

A convenience variant for loaders that are the most common type.

• GameFlags is which games this item loader is for.
• Item is the item type being loaded.

The ItemAdder function does not have to load exclusively this type of item. Related items are ok. The main use of the Item field is to get the path for this item type, so that files are loaded from that folder.

Full(GameFlags, Item, PdxEncoding, &'static str, bool, fn(_: &mut Db, _: Token, _: Block))

A variant that allows the full range of item loader behvavior.

• PdxEncoding indicates whether to expect utf-8 and/or a BOM in the files.
• The &'static str is the file extension to look for (including the dot).
• The bool is whether to load the whole file as one item, or treat it as normal with a series of items in one file.

Implementations

impl ItemLoader

pub fn for_game(&self, game: Game) -> bool

pub fn itype(&self) -> Item

pub fn encoding(&self) -> PdxEncoding

pub fn extension(&self) -> &'static str

pub fn whole_file(&self) -> bool

pub fn adder(&self) -> fn(_: &mut Db, _: Token, _: Block)

Trait Implementations

impl Collect for ItemLoader