Struct Repository

pub struct Repository {
    pub id: RepoId,
    pub backend: Repository,
}

Git implementation of WriteRepository using the git2 crate.

Fields

id: RepoId

The repository identifier (RID).

backend: Repository

The backing Git repository.

Implementations

impl Repository

pub fn open<P>(path: P, id: RepoId) -> Result<Repository, RepositoryError>

where P: AsRef<Path>,

Open an existing repository.

pub fn create<P>( path: P, id: RepoId, info: &UserInfo, ) -> Result<Repository, Error>

where P: AsRef<Path>,

Create a new repository.

pub fn remove(&self) -> Result<(), Error>

Remove an existing repository

pub fn clean( &self, local: &PublicKey, ) -> Result<Vec<PublicKey>, RepositoryError>

Remove all the remotes of a repository that are not the delegates of the repository or the local peer.

N.b. failure to delete remotes or references will not result in an early exit. Instead, this method continues to delete the next available remote or reference.

pub fn init<G, S>( doc: &Doc, storage: &S, signer: &Device<G>, ) -> Result<(Repository, Oid), RepositoryError>

where G: Signer<Signature>, S: WriteStorage,

Create the repository’s identity branch.

pub fn inspect(&self) -> Result<(), Error>

pub fn references( &self, ) -> Result<impl Iterator<Item = Result<Ref, Error>>, Error>

Iterate over all references.

pub fn project(&self) -> Result<Project, RepositoryError>

Get the canonical project information.

pub fn identity_doc_of(&self, remote: &PublicKey) -> Result<Doc, DocError>

pub fn remote_ids( &self, ) -> Result<impl Iterator<Item = Result<PublicKey, Error>>, Error>

pub fn remotes( &self, ) -> Result<impl Iterator<Item = Result<(PublicKey, Remote), Error>>, Error>

Trait Implementations

impl ReadRepository for Repository

fn id(&self) -> RepoId

Return the repository id.

fn is_empty(&self) -> Result<bool, Error>

Returns true if there are no references in the repository.

fn path(&self) -> &Path

The Path to the git repository.

fn blob_at<P>(&self, commit: Oid, path: P) -> Result<Blob<'_>, Error>

where P: AsRef<Path>,

Get a blob in this repository at the given commit and path.

fn blob(&self, oid: Oid) -> Result<Blob<'_>, Error>

Get a blob in this repository, given its id.

fn reference( &self, remote: &PublicKey, name: &Qualified<'_>, ) -> Result<Reference<'_>, Error>

Get the reference for the given remote.

fn reference_oid( &self, remote: &PublicKey, reference: &Qualified<'_>, ) -> Result<Oid, Error>

Get the object id of a reference under the given remote.

fn commit(&self, oid: Oid) -> Result<Commit<'_>, Error>

Get the git2::Commit found using its oid.

fn revwalk(&self, head: Oid) -> Result<Revwalk<'_>, Error>

Perform a revision walk of a commit history starting from the given head.

fn contains(&self, oid: Oid) -> Result<bool, Error>

Check if the underlying ODB contains the given oid.

fn is_ancestor_of(&self, ancestor: Oid, head: Oid) -> Result<bool, Error>

Check whether the given commit is an ancestor of another commit.

fn references_of(&self, remote: &PublicKey) -> Result<Refs, Error>

Get all references of the given remote.

fn references_glob( &self, pattern: &PatternStr, ) -> Result<Vec<(Qualified<'_>, Oid)>, Error>

Get all references following a pattern. Skips references with names that are not parseable into Qualified.

fn identity_doc_at(&self, head: Oid) -> Result<DocAt, DocError>

Get the repository’s identity document at a specific commit.

fn head(&self) -> Result<(Qualified<'_>, Oid), RepositoryError>

Get the head of this repository.

fn canonical_head(&self) -> Result<(Qualified<'_>, Oid), RepositoryError>

Compute the canonical head of this repository.

fn identity_head(&self) -> Result<Oid, RepositoryError>

Get the head of the rad/id reference in this repository.

fn identity_head_of(&self, remote: &PublicKey) -> Result<Oid, Error>

Get the identity head of a specific remote.

fn identity_root(&self) -> Result<Oid, RepositoryError>

Get the root commit of the canonical identity branch.

fn identity_root_of(&self, remote: &PublicKey) -> Result<Oid, RepositoryError>

Get the root commit of the identity branch of a sepcific remote.

fn canonical_identity_head(&self) -> Result<Oid, RepositoryError>

Compute the canonical rad/id of this repository.

fn merge_base(&self, left: &Oid, right: &Oid) -> Result<Oid, Error>

Get the merge base of two commits.

fn identity(&self) -> Result<Identity, RepositoryError>

where Self: Store,

Load the identity history.

fn canonical_identity_doc(&self) -> Result<DocAt, RepositoryError>

Compute the canonical identity document.

fn delegates(&self) -> Result<NonEmpty<Did>, RepositoryError>

Get repository delegates.

fn identity_doc(&self) -> Result<DocAt, RepositoryError>

Get the repository’s identity document.

impl RemoteRepository for Repository

fn remotes(&self) -> Result<Remotes<Verified>, Error>

Get all remotes.

fn remote(&self, remote: &PublicKey) -> Result<Remote, Error>

Get the given remote.

fn remote_refs_at(&self) -> Result<Vec<RefsAt>, Error>

Get RefsAt of all remotes.

impl SignRepository for Repository

fn sign_refs<G>( &self, signer: &Device<G>, ) -> Result<SignedRefs<Verified>, RepositoryError>

where G: Signer<Signature>,

Sign the repository’s refs under the refs/rad/sigrefs branch.

impl Storage for Repository

type StoreError = <Repository as Storage>::StoreError

type LoadError = <Repository as Storage>::LoadError

type ObjectId = <Repository as Storage>::ObjectId

type Parent = <Repository as Storage>::Parent

type Signatures = <Repository as Storage>::Signatures

fn store<Signer>( &self, authority: Option<<Repository as Storage>::Parent>, parents: Vec<<Repository as Storage>::Parent>, signer: &Signer, spec: Template<<Repository as Storage>::ObjectId>, ) -> Result<Entry<Oid, Oid, ExtendedSignature>, <Repository as Storage>::StoreError>

where Signer: Signer<ExtendedSignature>,

Store a new change entry.

fn load( &self, id: <Repository as Storage>::ObjectId, ) -> Result<Entry<Oid, Oid, ExtendedSignature>, <Repository as Storage>::LoadError>

Load a change entry.

fn parents_of( &self, id: &Oid, ) -> Result<Vec<Oid>, <Repository as Storage>::LoadError>

Returns the parents of the object with the specified ID.

impl Storage for Repository

type ObjectsError = ObjectsError

type TypesError = TypesError

type UpdateError = Error

type RemoveError = Error

type Namespace = PublicKey

fn objects( &self, typename: &TypeName, object_id: &ObjectId, ) -> Result<Objects, <Repository as Storage>::ObjectsError>

Get all references which point to a head of the change graph for a particular object

fn types( &self, typename: &TypeName, ) -> Result<BTreeMap<ObjectId, Objects>, <Repository as Storage>::TypesError>

Get all references to objects of a given type within a particular identity

fn update( &self, namespace: &<Repository as Storage>::Namespace, typename: &TypeName, object_id: &ObjectId, entry: &Oid, ) -> Result<(), <Repository as Storage>::UpdateError>

Update a ref to a particular collaborative object

fn remove( &self, namespace: &<Repository as Storage>::Namespace, typename: &TypeName, object_id: &ObjectId, ) -> Result<(), <Repository as Storage>::RemoveError>

Remove a ref to a particular collaborative object

impl ValidateRepository for Repository

fn validate_remote(&self, remote: &Remote) -> Result<Validations, Error>

Validates a remote’s signed refs and identity.

fn validate(&self) -> Result<Validations, Error>

Validate all remotes with ValidateRepository::validate_remote.

impl WriteRepository for Repository

fn set_head(&self) -> Result<SetHead, RepositoryError>

Set the repository head to the canonical branch. This computes the head based on the delegate set.

fn set_identity_head_to(&self, commit: Oid) -> Result<(), RepositoryError>

Set the repository ‘rad/id’ to the given commit.

fn set_remote_identity_root_to( &self, remote: &PublicKey, root: Oid, ) -> Result<(), RepositoryError>

Set the identity root reference to the given commit.

fn set_user(&self, info: &UserInfo) -> Result<(), Error>

Set the user info of the Git repository.

fn raw(&self) -> &Repository

Get the underlying git repository.

fn set_identity_head(&self) -> Result<Oid, RepositoryError>

Set the repository ‘rad/id’ to the canonical commit, agreed by quorum.

fn set_remote_identity_root( &self, remote: &PublicKey, ) -> Result<Oid, RepositoryError>

Set the identity root reference to the canonical identity root commit.

impl Store for Repository