Struct RecordRef 

pub struct RecordRef {
    pub did: String,
    pub collection: String,
    pub rkey: Option<String>,
}

What a reader addresses: a DID, a collection, and either one record key or the whole collection.

The authority is a DID and never a handle. A handle moves between accounts and a preference or a gate belongs to the account rather than to the name it currently answers to, so the cache is keyed by DID throughout and a caller holding a handle resolves it before it gets here.

A reference with no rkey reads the collection, which is what a policy’s lookup naming no record key asks for.

Fields

did: String

The repository’s DID.

collection: String

The collection (NSID) the record is in.

rkey: Option<String>

The record key, or None for every record in the collection.

Implementations

impl RecordRef

pub fn new( did: impl Into<String>, collection: impl Into<String>, rkey: impl Into<String>, ) -> Self

A reference to rkey in collection in did’s repository.

pub fn collection(did: impl Into<String>, collection: impl Into<String>) -> Self

A reference to every record in collection in did’s repository.

pub fn is_collection(&self) -> bool

Whether this names the whole collection rather than one record.

pub fn parse(at_uri: &str) -> Result<Self, RefError>

The record, or the collection, an at:// URI names.

Errors

See RefError: anything that is neither at://<did>/<collection>/<rkey> nor at://<did>/<collection>.

pub fn at_uri(&self) -> String

The at:// URI for this reference, which is also its cache key.

Trait Implementations

impl Clone for RecordRef

fn clone(&self) -> RecordRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordRef

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

Formats the value using the given formatter.

impl Display for RecordRef

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

Formats the value using the given formatter.

impl Hash for RecordRef

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 RecordRef

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

Tests for self and other values to be equal, and is used by ==.

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 Eq for RecordRef

impl StructuralPartialEq for RecordRef