Struct RepoHandle 

pub struct RepoHandle<'i> {
    pub did: Did<'i>,
    /* private fields */
}

handle to access data related to this repository.

Fields

did: Did<'i>

Implementations

impl<'i> RepoHandle<'i>

pub async fn get_record( &self, collection: &str, rkey: &str, ) -> Result<Option<Record>>

gets a record from this repository.

pub async fn list_records( &self, collection: &str, limit: usize, reverse: bool, cursor: Option<&str>, ) -> Result<RecordList>

lists records from this repository.

pub async fn generate_car( &self, ) -> Result<Option<impl Stream<Item = Result<Bytes>> + Send + 'static>>

generates a streaming CAR v1 response body for this repository.

returns None if the repo has no commit yet (still backfilling) or is an unmigrated repo that does not have the necessary data to reconstruct the root commit from.

notes

• calling this if you are using collection allowlist will always result in an error since the commit root won’t match the reconstructed CID.
• calling this for big repositories will incur more resource cost due to hydrant’s structure, the whole MST is always reconstructed.

pub async fn count_records(&self, collection: &str) -> Result<u64>

gets how many records of a collection this repository has.

impl<'i> RepoHandle<'i>

pub async fn info(&self) -> Result<Option<RepoInfo>>

fetch the current state of this repository. returns None if hydrant has never seen this repository.

pub async fn collections(&self) -> Result<HashMap<Nsid<'static>, u64>>

returns the collections of this repository and the number of records it has in each.

pub async fn mini_doc(&self) -> Result<MiniDoc<'static>, MiniDocError>

returns a bi-directionally validated mini doc.

Trait Implementations

impl<'i> Clone for RepoHandle<'i>

fn clone(&self) -> RepoHandle<'i>

Returns a duplicate of the value.

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

Performs copy-assignment from source.