Enum OverlayAccess

pub enum OverlayAccess {
    ReadOnly(OverlayId),
    ReadWrite((OverlayId, OverlayId)),
    WriteOnly(OverlayId),
}

Overlay Access

Used by the Client when opening or pinning a repo.

Variants

ReadOnly(OverlayId)

The repo will be accessed on the Outer Overlay in Read Only mode This can be used for Public, Protected or Group overlays Value should be an OverlayId::Outer

ReadWrite((OverlayId, OverlayId))

The repo will be accessed on the Inner Overlay in Write mode, and the associated Outer overlay is also given This is used for Public, Protected and Group overlays First value in tuple should be the OverlayId::Inner, second the OverlayId::Outer

WriteOnly(OverlayId)

The repo will be accessed on the Inner Overlay in Write mode, and it doesn’t have an Outer overlay This is used for Private and Dialog overlays Value should be an OverlayId::Inner

Implementations

impl OverlayAccess

pub fn is_read_only(&self) -> bool

pub fn new_write_access_from_store(store: &Store) -> OverlayAccess

pub fn new_read_access_from_store(store: &Store) -> OverlayAccess

pub fn new_ro(outer_overlay: OverlayId) -> Result<Self, NgError>

pub fn new_rw( inner_overlay: OverlayId, outer_overlay: OverlayId, ) -> Result<Self, NgError>

pub fn new_wo(inner_overlay: OverlayId) -> Result<Self, NgError>

pub fn overlay_id_for_client_protocol_purpose(&self) -> &OverlayId

Trait Implementations

impl Clone for OverlayAccess

fn clone(&self) -> OverlayAccess

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayAccess

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OverlayAccess

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for OverlayAccess

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OverlayAccess

fn eq(&self, other: &OverlayAccess) -> 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 OverlayAccess

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for OverlayAccess

impl Eq for OverlayAccess

impl StructuralPartialEq for OverlayAccess