Struct Replica 

pub struct Replica { /* private fields */ }

A persistent storage for git-bug data on disk.

For now this is always a git repository.

Implementations

impl Replica

pub fn from_path(path: impl Into<PathBuf>) -> Result<Self, Error>

Open a Replica from a path to a git repository.

This path is extended with .git, if the repository is non-bare and the path points into it.

Errors

If opening the repository fails.

pub fn repo(&self) -> &Repository

Access this Replica’s underlying repository.

pub fn db(&self) -> &Database

Access this Replica’s cache database.

pub fn get_all<E: Entity + EntityRead>( &self, ) -> Result<impl Iterator<Item = Result<Result<E, Error<E>>, Error>>, Error>

Return an iterator over all the Entities E stored in this replica.

Errors

• If the repository does not contain git-bug data (i.e., it was not initialized)

The iterator will error

• If the repository does not contain git-bug data (i.e., it was not initialized)
• If the git-bug data does not conform to the JSON schema.

pub fn get_all_with_query<E>( &self, query: &Query<Snapshot<E>>, ) -> Result<impl Iterator<Item = Result<Result<E, Error<E>>, Error>>, Error>

where Snapshot<E>: Queryable, E: Entity + EntityRead,

Return an iterator over all the Entities E stored in this replica that match the query.

Note

This calls Query::matches under the hood, and as such will produce snapshots for all Entities. In the future, this might be improved.

Errors

• If the repository does not contain git-bug data (i.e., it was not initialized)

The iterator will error

• If the repository does not contain git-bug data (i.e., it was not initialized)
• If the git-bug data does not conform to the JSON schema.

pub fn get_all_ids<E: Entity + EntityRead>( &self, ) -> Result<impl Iterator<Item = Result<EntityId<E>, Error>>, Error>

Return an iterator over all the EntityIds for the Entity E stored in this replica.

Note

This function does not have a _with_query variant, as such a variant would have to call Query::matches under the hood, and as such will create snapshots for all Entities.

If you only need to Ids of matched Entities use the following instead:

use git_bug::{
    entities::issue::Issue,
    query::{ParseMode, Query},
    replica::{
        Replica,
        entity::{Entity, snapshot::Snapshot},
    },
};

let query: Query<Snapshot<Issue>> =
    Query::from_continuous_str(replica, "title:test", ParseMode::Strict)?;

for maybe_entity in replica.get_all_with_query(&query)? {
    let entity = maybe_entity??;
    let id = entity.id();
    println!("Found id: {id}");
}

Errors

• If the repository does not contain git-bug data (i.e., it was not initialized)

Iterator Errors

• If one of the references could not be decoded.

pub fn get<E: Entity + EntityRead>( &self, id: EntityId<E>, ) -> Result<E, Error<E>>

Get an Entity by EntityId.

Note

This is useful if you have already obtained an EntityId via functions like Replica::get_all_ids. If you only have an Id, use the Replica::get_by_id function instead.

Errors

If the entity read operation (i.e., EntityRead::read fails.)

pub fn get_by_id<E: Entity + EntityRead>( &self, id: Id, ) -> Result<Result<E, Error<E>>, Error>

Get an Entity by it’s Id.

Note

This will search for the Id first and as such should not be used if you have already obtained an EntityId. If your Id is not found it will return an appropriate error.

Errors

If the entity read operation (i.e., EntityRead::read fails.)

pub fn contains<E: Entity + EntityRead>(&self) -> Result<bool, Error>

Convenience function, that checks whether git-bug data for an Entity has been stored in this replica.

Errors

• If iterating over the git references fails (e.g., because the underlying repository was never initialized.)

Trait Implementations

impl Debug for Replica

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

Formats the value using the given formatter.