Struct GitBackend 

pub struct GitBackend { /* private fields */ }

Git-backed storage backend.

Directory layout:

{root}/
  metadata.yaml          — store name, features, ID config, etc.
  objects/
    FR/000/FR-001.yaml   — individual requirement files (sharded)
    BUG/000/BUG-001.yaml
  relations/             — (future: append-only relation log)
  registry/              — (future: node/user registries)

Implementations

impl GitBackend

pub fn new(root: &Path) -> Result<Self>

Create a new git backend rooted at the given directory. Creates the directory structure if it doesn’t exist.

pub fn with_dispenser(self, dispenser: DispenserHandle) -> Self

Set the dispenser for ID generation (distributed mode).

pub fn with_auto_commit(self, enabled: bool) -> Self

Disable auto-commit (useful for batch operations or testing).

pub fn with_oplog(self, enabled: bool) -> Self

Enable or disable the operation log.

Trait Implementations

impl DatabaseBackend for GitBackend

fn backend_type(&self) -> BackendType

Returns the backend type

fn path(&self) -> &Path

Returns the path to the database file

fn load(&self) -> Result<RequirementsStore>

Loads the entire requirements store from the database

fn save(&self, store: &RequirementsStore) -> Result<()>

Saves the entire requirements store to the database

fn get_requirement_by_spec_id( &self, spec_id: &str, ) -> Result<Option<Requirement>>

Gets a requirement by its spec_id (e.g., “FR-001”)

fn get_requirement(&self, id: &Uuid) -> Result<Option<Requirement>>

Gets a requirement by its UUID

fn update_requirement(&self, requirement: &Requirement) -> Result<()>

Updates an existing requirement

fn delete_requirement(&self, id: &Uuid) -> Result<()>

Deletes a requirement by UUID

fn add_requirement(&self, requirement: Requirement) -> Result<Requirement>

Adds a new requirement Returns the requirement with assigned spec_id Note: This uses the simple SPEC-XXX format for ID generation. For more complex ID generation (with feature/type prefixes), use update_atomically

fn exists(&self) -> bool

Returns true if the database file exists

fn update_atomically<F>(&self, update_fn: F) -> Result<RequirementsStore>

where F: FnOnce(&mut RequirementsStore), Self: Sized,

Performs an atomic update operation Default implementation loads, applies changes, and saves

fn list_requirements(&self, include_archived: bool) -> Result<Vec<Requirement>>

Lists all requirements (non-archived by default)

fn update_requirement_versioned( &self, requirement: &Requirement, ) -> Result<UpdateResult>

Updates a requirement with optimistic locking

fn get_user(&self, id: &Uuid) -> Result<Option<User>>

Gets a user by UUID

fn get_user_by_handle(&self, handle: &str) -> Result<Option<User>>

Gets a user by handle

fn list_users(&self, include_archived: bool) -> Result<Vec<User>>

Lists all users

fn add_user(&self, user: User) -> Result<User>

Adds a new user

fn update_user(&self, user: &User) -> Result<()>

Updates an existing user

fn delete_user(&self, id: &Uuid) -> Result<()>

Deletes a user by UUID

fn get_name(&self) -> Result<String>

Gets the database name

fn set_name(&self, name: &str) -> Result<()>

Sets the database name

fn get_title(&self) -> Result<String>

Gets the database title

fn set_title(&self, title: &str) -> Result<()>

Sets the database title

fn get_description(&self) -> Result<String>

Gets the database description

fn set_description(&self, description: &str) -> Result<()>

Sets the database description

fn create_baseline( &self, name: String, description: Option<String>, created_by: String, ) -> Result<Baseline>

Creates a new baseline from current requirements For YAML backend, this also creates a git tag

fn list_baselines(&self) -> Result<Vec<Baseline>>

Lists all baselines

fn get_baseline(&self, id: &Uuid) -> Result<Option<Baseline>>

Gets a baseline by ID

fn delete_baseline(&self, id: &Uuid) -> Result<bool>

Deletes a baseline (if not locked)

fn compare_with_baseline( &self, baseline_id: &Uuid, ) -> Result<Option<BaselineComparison>>

Compares current state against a baseline

fn compare_baselines( &self, source_id: &Uuid, target_id: &Uuid, ) -> Result<Option<BaselineComparison>>

Compares two baselines

fn get_store_version(&self) -> Result<i64>

Gets the current store version (for detecting external modifications)

fn create_if_not_exists(&self) -> Result<()>

Creates the database with default/empty data if it doesn’t exist

fn queue_list( &self, _user_id: &str, _include_completed: bool, ) -> Result<Vec<QueueEntry>>

Lists queue entries for a user If include_completed is false, excludes entries whose requirement is Completed

fn queue_add(&self, _entry: QueueEntry) -> Result<()>

Adds an entry to a user’s queue

fn queue_remove(&self, _user_id: &str, _requirement_id: &Uuid) -> Result<()>

Removes an entry from a user’s queue

fn queue_reorder(&self, _user_id: &str, _items: &[(Uuid, i64)]) -> Result<()>

Reorders queue entries by updating positions

fn queue_clear(&self, _user_id: &str, _completed_only: bool) -> Result<()>

Clears queue entries. If completed_only is true, only removes entries whose requirement has status Completed.

fn stats(&self) -> Result<DatabaseStats>

Returns statistics about the database