Enum Commit

pub enum Commit {
    V0(CommitV0),
}

Commit Object

Variants

V0(CommitV0)

Implementations

impl Commit

pub fn new( author_privkey: &PrivKey, author_pubkey: &PubKey, overlay: OverlayId, branch: BranchId, quorum: QuorumType, deps: Vec<ObjectRef>, ndeps: Vec<ObjectRef>, acks: Vec<ObjectRef>, nacks: Vec<ObjectRef>, files: Vec<ObjectRef>, nfiles: Vec<ObjectRef>, metadata: Vec<u8>, body: ObjectRef, ) -> Result<Commit, NgError>

New commit

pub fn new_with_body_acks_deps_and_save( author_privkey: &PrivKey, author_pubkey: &PubKey, branch: BranchId, quorum: QuorumType, deps: Vec<ObjectRef>, acks: Vec<ObjectRef>, body: CommitBody, store: &Store, ) -> Result<Commit, NgError>

New commit with a body. everything is saved

pub fn new_with_body_and_save( author_privkey: &PrivKey, author_pubkey: &PubKey, branch: BranchId, quorum: QuorumType, deps: Vec<ObjectRef>, ndeps: Vec<ObjectRef>, acks: Vec<ObjectRef>, nacks: Vec<ObjectRef>, files: Vec<ObjectRef>, nfiles: Vec<ObjectRef>, metadata: Vec<u8>, body: CommitBody, block_size: usize, store: &Store, ) -> Result<Commit, NgError>

New commit with a body. everything is saved

pub fn reference(&self) -> Option<ObjectRef>

pub fn save( &mut self, block_size: usize, store: &Store, ) -> Result<ObjectRef, StorageError>

pub fn blocks(&self) -> &Vec<BlockId>

pub fn load( commit_ref: ObjectRef, store: &Store, with_body: bool, ) -> Result<Commit, CommitLoadError>

Load commit from store

pub fn load_body(&self, store: &Store) -> Result<&CommitBody, CommitLoadError>

Load commit body from store

pub fn header_id(&self) -> &Option<ObjectId>

Get ID of header Object

pub fn sig(&self) -> &Sig

Get commit signature

pub fn author(&self) -> &Digest

Get author (a UserId)

pub fn timestamp(&self) -> Timestamp

pub fn final_consistency(&self) -> bool

pub fn get_type(&self) -> Option<CommitType>

pub fn get_signature_reference(&self) -> Option<ObjectRef>

pub fn as_info(&self, repo: &Repo) -> CommitInfo

pub fn branch(&self) -> &BranchId

Get branch ID this commit is about

pub fn header(&self) -> &Option<CommitHeader>

Get commit header

pub fn body_ref(&self) -> &ObjectRef

pub fn content_v0(&self) -> &CommitContentV0

Get commit content V0

pub fn quorum_type(&self) -> &QuorumType

Get quorum_type

pub fn content(&self) -> &CommitContent

Get commit content

pub fn body(&self) -> Option<&CommitBody>

pub fn owners_signature_required( &self, store: &Store, ) -> Result<bool, CommitLoadError>

pub fn is_root_commit_of_branch(&self) -> bool

This commit is the first one in the branch (doesn’t have any ACKs nor Nacks)

pub fn acks(&self) -> Vec<ObjectRef>

Get acks (that have both an ID in the header and a key in the header_keys)

pub fn acks_ids(&self) -> Vec<ObjectId>

Get acks (that have an ID in the header, without checking if there is a key for them in the header_keys) if there is no header, returns an empty vec

pub fn deps_ids(&self) -> Vec<ObjectId>

Get deps (that have an ID in the header, without checking if there is a key for them in the header_keys) if there is no header, returns an empty vec

pub fn files(&self) -> Vec<ObjectRef>

Get files

pub fn deps(&self) -> Vec<ObjectRef>

Get deps (that have both an ID in the header and a key in the header_keys)

pub fn direct_causal_past(&self) -> Vec<ObjectRef>

Get all commits that are in the direct causal past of the commit (acks and nacks) only returns objectRefs that have both an ID from header and a KEY from header_keys (they all have a key)

pub fn direct_causal_past_ids(&self) -> HashSet<ObjectId>

pub fn verify_sig(&self, repo: &Repo) -> Result<(), CommitVerifyError>

Verify commit signature

pub fn verify_perm(&self, repo: &Repo) -> Result<(), NgError>

Verify commit permissions

pub fn verify_perm_creation( &self, user: Option<&Digest>, ) -> Result<&Digest, NgError>

pub fn verify_full_object_refs_of_branch_at_commit( &self, store: &Store, ) -> Result<Vec<ObjectId>, CommitLoadError>

Verify if the commit’s body and its direct_causal_past, and recursively all their refs are available in the store returns a list of all the ObjectIds that have been visited (only commits in the DAG) or a list of missing blocks

pub fn verify(&self, repo: &Repo) -> Result<(), NgError>

Verify signature, permissions, and full causal past

Trait Implementations

impl Clone for Commit

fn clone(&self) -> Commit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Commit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Commit

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

Formats the value using the given formatter.

impl IObject for Commit

fn id(&self) -> Option<ObjectId>

Get ID of including Object, only available if the Commit was loaded from store or saved

fn key(&self) -> Option<SymKey>

Get key of including Object only available if the Commit was loaded from store or saved

fn block_ids(&self) -> Vec<BlockId>

impl PartialEq for Commit

fn eq(&self, other: &Commit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Commit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Commit

impl StructuralPartialEq for Commit