Struct PinRepoV0

pub struct PinRepoV0 {
    pub hash: RepoHash,
    pub overlay: OverlayAccess,
    pub overlay_root_topic: Option<TopicId>,
    pub expose_outer: bool,
    pub peers: Vec<PeerAdvert>,
    pub max_peer_count: u16,
    pub ro_topics: Vec<TopicId>,
    pub rw_topics: Vec<PublisherAdvert>,
}

Request to pin a repo on the broker.

When client will disconnect, the subscriptions and publisherAdvert of the topics will remain active on the broker. replied with a RepoOpened

Fields

hash: RepoHash

Repo Hash

overlay: OverlayAccess

for RW overlay, the overlay that should be used in the clientmessage is the innerOverlay

overlay_root_topic: Option<TopicId>

Root topic of the overlay, used to listen to overlay refreshes. Only used for inner (RW or WO) overlays

expose_outer: bool

only possible for RW overlays. not allowed for private or dialog overlay

peers: Vec<PeerAdvert>

Broker peers to connect to in order to join the overlay If the repo has previously been opened (during the same session) or if it is a private overlay, then peers info can be omitted. If there are no known peers in the overlay yet, vector is left empty (creation of a store, or repo in a store that is owned by user).

max_peer_count: u16

Maximum number of peers to connect to for this overlay (only valid for an inner (RW/WO) overlay)

ro_topics: Vec<TopicId>

list of topics that should be subscribed to If the repo has previously been opened (during the same session) then ro_topics info can be omitted

rw_topics: Vec<PublisherAdvert>

list of topics for which we will be a publisher only possible with inner (RW or WO) overlays. If the repo has previously been opened (during the same session) then rw_topics info can be omitted

Trait Implementations

impl Clone for PinRepoV0

fn clone(&self) -> PinRepoV0

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PinRepoV0

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PinRepoV0

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PinRepoV0

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

where __S: Serializer,

Serialize this value into the given Serde serializer.