Struct noosphere_core::data::LinkRecord

pub struct LinkRecord(/* private fields */);

A LinkRecord is a wrapper around a decoded Jwt (Ucan), representing a link address as a Cid to a sphere.

Implementations

impl LinkRecord

pub async fn validate<S: UcanJwtStore>(&self, store: &S) -> Result<()>

Validates the Ucan token as a LinkRecord, ensuring that the sphere’s owner authorized the publishing of a new content address. Notably does not check the publishing timeframe permissions, as an expired token can be considered valid. Returns an Err if validation fails.

pub fn has_publishable_timeframe(&self) -> bool

Returns true if the Ucan token is currently publishable within the bounds of its expiry/not before time.

pub fn to_sphere_identity(&self) -> Did

The DID key of the sphere that this record maps.

pub fn get_link(&self) -> Option<Link<MemoIpld>>

The sphere revision address (Link) that the sphere’s identity maps to.

pub fn superceded_by(&self, other: &LinkRecord) -> bool

Returns a boolean indicating whether the other LinkRecord is a newer record referring to the same identity. Underlying Ucan expiry is used to compare. A record with null expiry cannot supercede or be superceded.

pub async fn collect_proofs<S>(&self, store: &S) -> Result<Vec<Ucan>>where S: UcanJwtStore,

Walk the underlying Ucan and collect all of the supporting proofs that verify the link publisher’s authority to publish the link

Methods from Deref<Target = Ucan>

pub async fn validate<'a>( &self, now_time: Option<u64>, did_parser: &mut DidParser ) -> Result<(), Error>

Validate the UCAN’s signature and timestamps

pub async fn check_signature<'a>( &self, did_parser: &mut DidParser ) -> Result<(), Error>

Validate that the signed data was signed by the stated issuer

pub fn encode(&self) -> Result<String, Error>

Produce a base64-encoded serialization of the UCAN suitable for transferring in a header field

pub fn is_expired(&self, now_time: Option<u64>) -> bool

Returns true if the UCAN has past its expiration date

pub fn signed_data(&self) -> &[u8]

Raw bytes of signed data for this UCAN

pub fn signature(&self) -> &[u8]

pub fn is_too_early(&self) -> bool

Returns true if the not-before (“nbf”) time is still in the future

pub fn lifetime_begins_before(&self, other: &Ucan) -> bool

Returns true if this UCAN’s lifetime begins no later than the other Note that if a UCAN specifies an NBF but the other does not, the other has an unbounded start time and this function will return false.

pub fn lifetime_ends_after(&self, other: &Ucan) -> bool

Returns true if this UCAN expires no earlier than the other

pub fn lifetime_encompasses(&self, other: &Ucan) -> bool

Returns true if this UCAN’s lifetime fully encompasses the other

pub fn algorithm(&self) -> &str

pub fn issuer(&self) -> &str

pub fn audience(&self) -> &str

pub fn proofs(&self) -> &Option<Vec<String>>

pub fn expires_at(&self) -> &Option<u64>

pub fn not_before(&self) -> &Option<u64>

pub fn nonce(&self) -> &Option<String>

pub fn attenuation(&self) -> &Capabilities

👎Deprecated since 0.4.0: use capabilities()

pub fn capabilities(&self) -> &Capabilities

pub fn facts(&self) -> &Option<BTreeMap<String, Value>>

pub fn version(&self) -> &str

pub fn to_cid(&self, hasher: Code) -> Result<Cid<64>, Error>

Trait Implementations

impl Clone for LinkRecord

fn clone(&self) -> LinkRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkRecord

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

Formats the value using the given formatter.

impl Deref for LinkRecord

type Target = Ucan

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for LinkRecord

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LinkRecord

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

Formats the value using the given formatter.

impl From<&LinkRecord> for Ucan

fn from(value: &LinkRecord) -> Self

Converts to this type from the input type.

impl From<&Ucan> for LinkRecord

fn from(value: &Ucan) -> Self

Converts to this type from the input type.

impl From<LinkRecord> for Ucan

fn from(value: LinkRecord) -> Self

Converts to this type from the input type.

impl From<Ucan> for LinkRecord

fn from(value: Ucan) -> Self

Converts to this type from the input type.

impl FromStr for LinkRecord

type Err = Error

The associated error which can be returned from parsing.

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

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

impl PartialEq for LinkRecord

LinkRecords compare their Jwt representations for equality. If a record cannot be encoded as such, they will not be considered equal to any other record.

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LinkRecord

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryBundle for LinkRecord

fn extend_bundle<'life0, 'life1, 'life2, 'async_trait, S>( &'life0 self, bundle: &'life1 mut Bundle, store: &'life2 S ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where S: 'async_trait + BlockStore, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn extend_bundle_with_cid<'life0, 'life1, 'life2, 'async_trait, S>( cid: &'life0 Cid, bundle: &'life1 mut Bundle, store: &'life2 S ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where S: 'async_trait + BlockStore, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn bundle<'life0, 'life1, 'async_trait, S>( &'life0 self, store: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Bundle>> + Send + 'async_trait>>where S: 'async_trait + BlockStore, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn bundle_with_cid<'life0, 'life1, 'async_trait, S>( cid: &'life0 Cid, store: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Bundle>> + Send + 'async_trait>>where S: 'async_trait + BlockStore, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl TryFrom<&[u8]> for LinkRecord

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Jwt> for LinkRecord

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Jwt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&LinkRecord> for Jwt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &LinkRecord) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Jwt> for LinkRecord

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Jwt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<LinkRecord> for Jwt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: LinkRecord) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<LinkRecord> for Vec<u8>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: LinkRecord) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for LinkRecord

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for LinkRecord

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for LinkRecord