Struct noosphere_api::client::Client

pub struct Client<K, S>where
    K: KeyMaterial + Clone + 'static,
    S: UcanStore,{
    pub session: IdentifyResponse,
    pub sphere_identity: String,
    pub api_base: Url,
    pub author: Author<K>,
    pub store: S,
    /* private fields */
}

A Client is a simple, portable HTTP client for the Noosphere gateway REST API. It embodies the intended usage of the REST API, which includes an opening handshake (with associated key verification) and various UCAN-authorized verbs over sphere data.

Fields

session: IdentifyResponse

sphere_identity: String

api_base: Url

author: Author<K>

store: S

Implementations

impl<K, S> Client<K, S>where K: KeyMaterial + Clone + 'static, S: UcanStore,

pub async fn identify( sphere_identity: &str, api_base: &Url, author: &Author<K>, did_parser: &mut DidParser, store: S ) -> Result<Client<K, S>>

pub async fn replicate( &self, memo_version: &Cid, params: Option<&ReplicateParameters> ) -> Result<impl Stream<Item = Result<(Cid, Vec<u8>)>>>

Replicate content from Noosphere, streaming its blocks from the configured gateway. If the gateway doesn’t have the desired content, it will look it up from other sources such as IPFS if they are available. Note that this means this call can potentially block on upstream access to an IPFS node (which, depending on the node’s network configuration and peering status, can be quite slow).

pub async fn fetch( &self, params: &FetchParameters ) -> Result<Option<(Link<MemoIpld>, impl Stream<Item = Result<(Cid, Vec<u8>)>>)>>

pub async fn push( &self, push_body: &PushBody ) -> Result<PushResponse, PushError>