Struct BranchV0

pub struct BranchV0 {
    pub id: PubKey,
    pub crdt: BranchCrdt,
    pub repo: ObjectRef,
    pub root_branch_readcap_id: ObjectId,
    pub topic: PubKey,
    pub topic_privkey: Vec<u8>,
    pub pulled_from: Vec<u8>,
    pub metadata: Vec<u8>,
}

Branch definition

First commit in a branch, signed by branch key In case of a fork, the commit DEPS indicate the previous branch heads, and the ACKS are empty.

Can be used also to update the branch definition when users are removed In this case, the total_order quorum is needed, and DEPS indicates the BranchCapRefresh commit

Fields

id: PubKey

Branch public key ID

crdt: BranchCrdt

repo: ObjectRef

Reference to the repository commit

root_branch_readcap_id: ObjectId

object ID of the current root_branch commit (ReadCap), in order to keep in sync this branch with root_branch The key is not provided as external readers should not be able to access the root branch definition. it is only used by verifiers (who have the key already)

topic: PubKey

Pub/sub topic for publishing events

topic_privkey: Vec<u8>

topic private key (a BranchWriteCapSecret), encrypted with a key derived as follow BLAKE3 derive_key (“NextGraph Branch WriteCap Secret BLAKE3 key”, RepoWriteCapSecret, TopicId, BranchId ) so that only editors of the repo can decrypt the privkey For individual store repo, the RepoWriteCapSecret is zero

pulled_from: Vec<u8>

optional: this branch is the result of a pull request coming from another repo. contains a serialization of a ReadBranchLink of a transactional branch from another repo

metadata: Vec<u8>

App-specific metadata

Implementations

impl BranchV0

pub fn new( id: PubKey, repo: ObjectRef, root_branch_readcap_id: ObjectId, topic_priv: PrivKey, metadata: Vec<u8>, ) -> BranchV0

Trait Implementations

impl Clone for BranchV0

fn clone(&self) -> BranchV0

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchV0

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchV0

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BranchV0

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

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

const 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 BranchV0

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 BranchV0

impl StructuralPartialEq for BranchV0