Struct IdentityMut

pub struct IdentityMut<'a, R> {
    pub id: ObjectId,
    /* private fields */
}

Fields

id: ObjectId

Implementations

impl<R> IdentityMut<'_, R>

where R: WriteRepository + Store<Namespace = PublicKey>,

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

Reload the identity data from storage.

pub fn transaction<G, F>( &mut self, message: &str, signer: &Device<G>, operations: F, ) -> Result<Oid, Error>

where G: Signer<Signature>, F: FnOnce(&mut Transaction<Identity, R>, &R) -> Result<(), Error>,

pub fn update<G>( &mut self, title: impl ToString, description: impl ToString, doc: &Doc, signer: &Device<G>, ) -> Result<Oid, Error>

where G: Signer<Signature>,

Update the identity by proposing a new revision. If the signer is the only delegate, the revision is accepted automatically.

pub fn accept<G>( &mut self, revision: &Oid, signer: &Device<G>, ) -> Result<Oid, Error>

where G: Signer<Signature>,

Accept an active revision.

pub fn reject<G>( &mut self, revision: Oid, signer: &Device<G>, ) -> Result<Oid, Error>

where G: Signer<Signature>,

Reject an active revision.

pub fn redact<G>( &mut self, revision: Oid, signer: &Device<G>, ) -> Result<Oid, Error>

where G: Signer<Signature>,

Redact a revision.

pub fn edit<G>( &mut self, revision: Oid, title: String, description: String, signer: &Device<G>, ) -> Result<Oid, Error>

where G: Signer<Signature>,

Edit an active revision’s title or description.

Methods from Deref<Target = Identity>

pub fn id(&self) -> RepoId

The repository identifier.

pub fn doc(&self) -> &Doc

The current document.

pub fn current(&self) -> &Revision

The current revision.

pub fn root(&self) -> &Revision

The initial revision of this identity.

pub fn head(&self) -> Oid

The head of the identity branch. This points to a commit that contains the current document blob.

pub fn revision(&self, revision: &Oid) -> Option<&Revision>

A specific Revision, that may be redacted.

pub fn revisions(&self) -> impl DoubleEndedIterator

All the Revisions that have not been redacted.

pub fn latest_by(&self, who: &Did) -> Option<&Revision>

Methods from Deref<Target = Revision>

pub fn signatures(&self) -> impl Iterator<Item = (&PublicKey, Signature)>

pub fn is_accepted(&self) -> bool

pub fn is_active(&self) -> bool

pub fn verdicts(&self) -> impl Iterator<Item = (&PublicKey, &Verdict)>

pub fn accepted(&self) -> impl Iterator<Item = Did>

pub fn rejected(&self) -> impl Iterator<Item = Did>

pub fn sign<G>(&self, signer: &G) -> Result<Signature, DocError>

where G: Signer<Signature>,

Methods from Deref<Target = Doc>

pub fn version(&self) -> &Version

Get the version of the document.

pub fn payload(&self) -> &BTreeMap<PayloadId, Payload>

Return the associated payloads for this Doc.

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

Get the project payload, if it exists and is valid, out of this document.

pub fn default_branch_rule( &self, ) -> Result<(Pattern, Rule<ResolvedDelegates, Threshold>), DefaultBranchRuleError>

pub fn visibility(&self) -> &Visibility

Return the associated Visibility of this document.

pub fn is_public(&self) -> bool

Check whether the visibility of the document is public.

pub fn is_private(&self) -> bool

Check whether the visibility of the document is private.

pub fn threshold(&self) -> usize

Return the associated threshold of this document.

pub fn threshold_nonzero(&self) -> &NonZero<usize>

Return the associated threshold of this document in its non-zero format.

pub fn delegates(&self) -> &Delegates

Return the associated delegates of this document.

pub fn is_delegate(&self, did: &Did) -> bool

Check if the did is part of the Doc::delegates set.

pub fn is_visible_to(&self, did: &Did) -> bool

Check whether this document and the associated repository is visible to the given peer.

pub fn verify_signature( &self, key: &PublicKey, signature: &Signature, blob: Oid, ) -> Result<(), PublicKey>

Validate signature using this document’s delegates, against a given document blob.

pub fn is_majority(&self, votes: usize) -> bool

Check the provided votes passes the Doc::majority.

pub fn majority(&self) -> usize

Return the majority number based on the size of the delegates set.

pub fn encode(&self) -> Result<(Oid, Vec<u8>), DocError>

Encode the Doc as canonical JSON, returning the set of bytes and its corresponding Git Oid.

pub fn sign<G>(&self, signer: &G) -> Result<(Oid, Vec<u8>, Signature), DocError>

where G: Signer<Signature>,

Doc::encode and sign the Doc, returning the set of bytes, its corresponding Git Oid and the Signature over the Oid.

pub fn signature_of<G>(&self, signer: &G) -> Result<Signature, DocError>

where G: Signer<Signature>,

Similar to Doc::sign, but only returning the Signature.

pub fn init<G>( &self, repo: &Repository, signer: &Device<G>, ) -> Result<Oid, RepositoryError>

where G: Signer<Signature>,

Initialize an identity::Identity with this Doc as the associated document.

Trait Implementations

impl<R> Debug for IdentityMut<'_, R>

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

Formats the value using the given formatter.

impl<R> Deref for IdentityMut<'_, R>

type Target = Identity

The resulting type after dereferencing.

fn deref(&self) -> &<IdentityMut<'_, R> as Deref>::Target

Dereferences the value.