Struct ReadBranchLinkV0

pub struct ReadBranchLinkV0 {
    pub repo: RepoId,
    pub branch: BranchId,
    pub topic: TopicId,
    pub heads: Vec<ObjectRef>,
    pub read_cap: ReadCap,
    pub overlay: OverlayLink,
    pub peers: Vec<PeerAdvert>,
}

Read access to a branch of a Public, Protected or Group store.

The overlay to join can be the outer or the inner, depending on what was offered in the link. The difference between the two is that in the outer overlay, only one broker is contacted. In the inner overlay, all the publisher’s brokers are contacted, so subscription to the pub/sub is more reliable, less prone to outage. This is not a durable link. If the topic has been refreshed, the pubsub won’t be able to be subscribed to, but TopicSyncReq will still work (answering the commits up until the moment the topic was refreshed) and the optional heads will always be retrievable

Fields

repo: RepoId

Repository ID

branch: BranchId

topic: TopicId

heads: Vec<ObjectRef>

an optional list of heads that can be fetched in this branch useful if a specific head is to be shared

read_cap: ReadCap

read capability for the branch current (at the time of sharing the link) branch definition commit

overlay: OverlayLink

Current overlay link, used to join the overlay, most of the time, an outerOverlay is preferred

peers: Vec<PeerAdvert>

Peer brokers to connect to

Trait Implementations

impl Clone for ReadBranchLinkV0

fn clone(&self) -> ReadBranchLinkV0

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadBranchLinkV0

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadBranchLinkV0

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ReadBranchLinkV0

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

where __S: Serializer,

Serialize this value into the given Serde serializer.