Struct PrivateLink 

#[non_exhaustive]
pub struct PrivateLink {
    pub manifest: Hash,
    pub capability: [u8; 32],
    pub expires_at: u64,
}

A bearer capability link to a private manifest.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

manifest: Hash

Immutable manifest granted by this capability.

capability: [u8; 32]

Secret read capability. It is intentionally included in the URI.

expires_at: u64

Unix timestamp after which the capability is no longer accepted.

Implementations

impl PrivateLink

pub fn generate(manifest: Hash, expires_at: u64) -> Result<Self>

Generate a private capability link with a cryptographically random bearer token.

Errors

Returns an error if the expiration is invalid.

pub fn parse(value: &str) -> Result<Self>

Parse a private capability URI.

Errors

Returns an error if the URI, hash, capability, or expiration is malformed.

pub fn new( manifest: Hash, capability: [u8; 32], expires_at: u64, ) -> Result<Self>

Create a private capability link.

Errors

Returns an error if the capability or expiration is invalid.

pub fn uri(&self) -> String

Return the canonical capability URI.

pub fn validate(&self) -> Result<()>

Validate the capability and expiry.

Errors

Returns an error if the expiration is zero.

pub const fn is_expired_at(&self, now: u64) -> bool

Return whether this link is expired at now.

pub fn revocation_key(&self) -> (Hash, Vec<u8>)

Return a stable key used by revocation lists.

Trait Implementations

impl Clone for PrivateLink

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateLink

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrivateLink

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrivateLink

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

Formats the value using the given formatter.

impl Eq for PrivateLink

impl FromStr for PrivateLink

type Err = SyncwebError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for PrivateLink

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 PrivateLink

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PrivateLink

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PrivateLink