Struct DraftStore

pub struct DraftStore<'a, R> { /* private fields */ }

Stores draft collaborative objects.

Implementations

impl<'a, R> DraftStore<'a, R>

pub fn new(repo: &'a R, remote: PublicKey) -> DraftStore<'a, R>

Trait Implementations

impl<R> ReadRepository for DraftStore<'_, R>

where R: ReadRepository,

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 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 path(&self) -> &Path

The Path to the git repository.

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 blob_at<P>(&self, oid: 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, reference: &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 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(&self) -> Result<DocAt, RepositoryError>

Get the repository’s identity document.

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

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

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.

impl<R> RemoteRepository for DraftStore<'_, R>

where R: RemoteRepository,

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

Get the given remote.

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

Get all remotes.

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

Get RefsAt of all remotes.

impl<R> SignRepository for DraftStore<'_, R>

where R: ReadRepository,

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<R> Storage for DraftStore<'_, R>

where R: WriteRepository,

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<<DraftStore<'_, R> as Storage>::Parent>, parents: Vec<<DraftStore<'_, R> as Storage>::Parent>, signer: &Signer, spec: Template<<DraftStore<'_, R> as Storage>::ObjectId>, ) -> Result<Entry<Oid, Oid, ExtendedSignature>, <DraftStore<'_, R> as Storage>::StoreError>

where Signer: Signer<ExtendedSignature>,

Store a new change entry.

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

Load a change entry.

fn parents_of( &self, id: &Oid, ) -> Result<Vec<Oid>, <DraftStore<'_, R> as Storage>::LoadError>

Returns the parents of the object with the specified ID.

impl<R> Storage for DraftStore<'_, R>

where R: WriteRepository,

type ObjectsError = ObjectsError

type TypesError = Error

type UpdateError = Error

type RemoveError = Error

type Namespace = PublicKey

fn objects( &self, typename: &TypeName, object_id: &ObjectId, ) -> Result<Objects, <DraftStore<'_, R> 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>, <DraftStore<'_, R> as Storage>::TypesError>

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

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

Update a ref to a particular collaborative object

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

Remove a ref to a particular collaborative object

impl<R> ValidateRepository for DraftStore<'_, R>

where R: ValidateRepository,

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<R> Store for DraftStore<'_, R>

where R: WriteRepository,