Skip to main content

Crate kizz_store

Crate kizz_store 

Source
Expand description

The kizz cache: its location, its lock file, and the store of typed records.

  • location: the cache is KIZZ_CACHE_DIR when set, otherwise $XDG_CACHE_HOME/kizz, otherwise ~/.cache/kizz.
  • lock: one process at a time holds kizz.lock in the cache directory, and any other waits and says what it is waiting for.
  • store: the records live in SurrealKV, embedded, in the db directory of the cache, as CBOR encoded with minicbor; the store starts no thread of its own.
  • identity: the stamp of the machine and user that the cache belongs to, which the store writes into a new database and compares on every later open.
  • records: the record families, their key layout, and their typed records.
  • step: the contents of step records: the step specification, the observations with their path states, and how the step ended.
  • machine: the machine state that each step record keeps, and how the parts that a step names are compared and shown.
  • explanation: the contents of explanations: why a step ran, or that it was cached, as the step-position records keep them for kizz why.

Re-exports§

pub use explanation::BuildId;
pub use explanation::ChangedInput;
pub use explanation::EnvChange;
pub use explanation::Explanation;
pub use explanation::ModuleChange;
pub use explanation::ModuleChangeKind;
pub use explanation::Reason;
pub use explanation::SelfInflicted;
pub use explanation::TaskLabel;
pub use explanation::Verdict;
pub use explanation::Writer;
pub use identity::CacheIdentity;
pub use identity::IdentityDifference;
pub use identity::IdentityKey;
pub use identity::IdentityPart;
pub use identity::identity_differences_text;
pub use location::LocationError;
pub use location::cache_dir;
pub use location::cache_dir_from_env;
pub use lock::CacheLock;
pub use lock::LOCK_FILE_NAME;
pub use lock::LockDetails;
pub use lock::LockError;
pub use lock::LockOptions;
pub use machine::DiskRecord;
pub use machine::FileSystemRecord;
pub use machine::KernelRecord;
pub use machine::LimitRecord;
pub use machine::MachineChange;
pub use machine::MachinePart;
pub use machine::MachineStateRecord;
pub use machine::MemoryRecord;
pub use machine::machine_changes;
pub use machine::machine_changes_text;
pub use records::Family;
pub use records::LastWriter;
pub use records::LearnedOrder;
pub use records::ModuleHash;
pub use records::PathKey;
pub use records::PositionKey;
pub use records::Record;
pub use records::RecordKey;
pub use records::SchemaKey;
pub use records::SchemaVersion;
pub use records::StepKey;
pub use records::StepPosition;
pub use records::TaskId;
pub use records::TaskRecord;
pub use records::WrittenBy;
pub use records::database_key;
pub use records::path_prefix;
pub use step::AccessBits;
pub use step::Attribute;
pub use step::Attributes;
pub use step::Capture;
pub use step::Change;
pub use step::ChangedRead;
pub use step::Connection;
pub use step::ContentHash;
pub use step::Difference;
pub use step::DirEntry;
pub use step::EntryKind;
pub use step::FileMeta;
pub use step::Listing;
pub use step::MAX_LISTED_NAMES;
pub use step::NotCachedReason;
pub use step::Observation;
pub use step::Owner;
pub use step::PERMISSION_BITS;
pub use step::PathState;
pub use step::ProgramPath;
pub use step::RecordedOutput;
pub use step::RunReason;
pub use step::SpecialKind;
pub use step::StepExit;
pub use step::StepRecord;
pub use step::StepSpecRecord;
pub use step::Times;
pub use step::changed_reads_text;
pub use step::connections_text;
pub use step::permission_bits;
pub use step::system_call_numbers;
pub use store::DATABASE_DIR;
pub use store::EntryCounts;
pub use store::Inventory;
pub use store::SCHEMA_VERSION;
pub use store::STALL_THRESHOLD;
pub use store::Store;
pub use store::StoreError;
pub use store::Txn;

Modules§

explanation
The contents of explanations: why a step ran, or that it was cached, as a build decided it (“Explaining decisions”).
identity
The cache identity: the stamp of the machine and the user that a cache belongs to.
location
The location of the cache directory.
lock
The cache lock file, kizz.lock in the cache directory.
machine
The machine state that step records keep (“Machine state”).
records
The typed records of the cache database and the layout of their keys.
step
The contents of step records.
store
The cache database: SurrealKV, embedded, in the db directory of the cache.