Crate prc

Re-exports

pub use prc_trait::Prc;

pub use hash40;

Modules

prc_trait

Structs

ParamList

A list of params.

ParamStruct

A list of key-value pairs of params. Acts essentially like a hash-map, but is presented in list form to preserve key order, as well as to handle rare cases where a key may be duplicated. Keys are hashed strings, represented by the Hash40 type.

Enums

ParamKind

The central data structure to param files and params. Similar to tree-like recursive data formats such as JSON.

Functions

open

Attempts to read a param file from the given filepath. Returns a ParamStruct if successful, otherwise an Error.

read_stream

Attempts to read a param file from the given reader (requires Seek). The reader should be positioned at the header of the filetype. Returns a ParamStruct if successful, otherwise an Error.

save

Attempts to write a param file into the given filepath. Returns nothing if successful, otherwise an Error.

write_stream

Attempts to write a param file into the given writer (requires Seek). Returns nothing if successful, otherwise an Error.

Derive Macros

Prc