Enum iroh_docs::sync::Capability

pub enum Capability {
    Write(NamespaceSecret),
    Read(NamespaceId),
}

The capability of the namespace.

Variants

Write(NamespaceSecret)

Write access to the namespace.

Read(NamespaceId)

Read only access to the namespace.

Implementations

impl Capability

pub fn id(&self) -> NamespaceId

Get the NamespaceId for this Capability.

pub fn secret_key(&self) -> Result<&NamespaceSecret, ReadOnly>

Get the NamespaceSecret of this Capability. Will fail if the Capability is read only.

pub fn kind(&self) -> CapabilityKind

Get the kind of capability.

pub fn raw(&self) -> (u8, [u8; 32])

Get the raw representation of this namespace capability.

pub fn from_raw(kind: u8, bytes: &[u8; 32]) -> Result<Self>

Create a Capability from its raw representation.

pub fn merge(&mut self, other: Capability) -> Result<bool, CapabilityError>

Merge this capability with another capability.

Will return an error if other is not a capability for the same namespace.

Returns true if the capability was changed, false otherwise.

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Capability

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NamespaceId> for Capability

fn from(value: NamespaceId) -> Self

Converts to this type from the input type.

impl From<NamespaceSecret> for Capability

fn from(value: NamespaceSecret) -> Self

Converts to this type from the input type.

impl Serialize for Capability

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

where __S: Serializer,

Serialize this value into the given Serde serializer.