Struct holochain_cascade::Cascade

pub struct Cascade<Network = HolochainP2pDna> { /* fields omitted */ }

Implementations

impl<Network> Cascade<Network> where
    Network: HolochainP2pDnaT + Clone + 'static + Send, 

pub fn with_authored(self, authored: DbRead<DbKindAuthored>) -> Self

Add the authored env to the cascade.

pub fn with_private_data(self, author: Arc<AgentPubKey>) -> Self

Add the ability to access private entries for this agent.

pub fn with_dht(self, dht: DbRead<DbKindDht>) -> Self

Add the dht env to the cascade.

pub fn with_cache(self, cache: DbWrite<DbKindCache>) -> Self

Add the cache to the cascade.

pub fn with_scratch(self, scratch: SyncScratch) -> Self

Add the cache to the cascade.

pub fn with_network<N: HolochainP2pDnaT + Clone>(
    self,
    network: N,
    cache_env: DbWrite<DbKindCache>
) -> Cascade<N>

Add the network and cache to the cascade.

impl Cascade<HolochainP2pDna>

pub fn empty() -> Self

Constructs an empty Cascade.

pub fn from_workspace_network<N, AuthorDb, DhtDb>(
    workspace: &HostFnWorkspace<AuthorDb, DhtDb>,
    network: N
) -> Cascade<N> where
    N: HolochainP2pDnaT + Clone,
    AuthorDb: ReadAccess<DbKindAuthored>,
    DhtDb: ReadAccess<DbKindDht>, 

pub fn from_workspace(
    stores: HostFnStores,
    author: Option<Arc<AgentPubKey>>
) -> Self

impl<Network> Cascade<Network> where
    Network: HolochainP2pDnaT + Clone + 'static + Send, 

pub async fn retrieve_entry(
    &mut self,
    hash: EntryHash,
    options: NetworkGetOptions
) -> CascadeResult<Option<EntryHashed>>

Retrieve Entry from either locally or from an authority. Data might not have been validated yet by the authority.

pub async fn retrieve_header(
    &mut self,
    hash: HeaderHash,
    options: NetworkGetOptions
) -> CascadeResult<Option<SignedHeaderHashed>>

Retrieve SignedHeaderHashed from either locally or from an authority. Data might not have been validated yet by the authority.

pub async fn retrieve(
    &mut self,
    hash: AnyDhtHash,
    options: NetworkGetOptions
) -> CascadeResult<Option<Element>>

Retrieve data from either locally or from an authority. Data might not have been validated yet by the authority.

pub async fn get_entry_details(
    &mut self,
    entry_hash: EntryHash,
    options: GetOptions
) -> CascadeResult<Option<EntryDetails>>

pub async fn get_header_details(
    &mut self,
    header_hash: HeaderHash,
    options: GetOptions
) -> CascadeResult<Option<ElementDetails>>

pub async fn dht_get_header(
    &mut self,
    header_hash: HeaderHash,
    options: GetOptions
) -> CascadeResult<Option<Element>>

Returns the Element for this HeaderHash if it is live by getting the latest available metadata from authorities combined with this agents authored data. Note: Deleted headers are a tombstone set

pub async fn dht_get_entry(
    &mut self,
    entry_hash: EntryHash,
    options: GetOptions
) -> CascadeResult<Option<Element>>

Returns the oldest live Element for this EntryHash by getting the latest available metadata from authorities combined with this agents authored data.

pub async fn get_concurrent<I: IntoIterator<Item = AnyDhtHash>>(
    &mut self,
    hashes: I,
    options: GetOptions
) -> CascadeResult<Vec<Option<Element>>>

pub async fn dht_get(
    &mut self,
    hash: AnyDhtHash,
    options: GetOptions
) -> CascadeResult<Option<Element>>

Updates the cache with the latest network authority data and returns what is in the cache. This gives you the latest possible picture of the current dht state. Data from your zome call is also added to the cache.

pub async fn get_details(
    &mut self,
    hash: AnyDhtHash,
    options: GetOptions
) -> CascadeResult<Option<Details>>

pub async fn dht_get_links(
    &mut self,
    key: WireLinkKey,
    options: GetLinksOptions
) -> CascadeResult<Vec<Link>>

Gets an links from the cas or cache depending on it’s metadata

pub async fn get_link_details(
    &mut self,
    key: WireLinkKey,
    options: GetLinksOptions
) -> CascadeResult<Vec<(SignedHeaderHashed, Vec<SignedHeaderHashed>)>>

Return all CreateLink headers and DeleteLink headers ordered by time.

pub async fn get_agent_activity(
    &mut self,
    agent: AgentPubKey,
    query: ChainQueryFilter,
    options: GetActivityOptions
) -> CascadeResult<AgentActivityResponse<Element>>

Get agent activity from agent activity authorities. Hashes are requested from the authority and cache for valid chains. Options:

• include_valid_activity will include the valid chain hashes.
• include_rejected_activity will include the invalid chain hashes.
• include_full_headers will fetch the valid headers in parallel (requires include_valid_activity) Query:
• include_entries will also fetch the entries in parallel (requires include_full_headers)
• sequence_range will get all the activity in the exclusive range
• header_type and entry_type will filter the activity (requires include_full_headers)

pub fn get_validation_package_local(
    &self,
    _hash: &HeaderHash
) -> CascadeResult<Option<Vec<Element>>>

Get the validation package if it is cached without going to the network

pub async fn get_validation_package(
    &mut self,
    _agent: AgentPubKey,
    _header: &HeaderHashed
) -> CascadeResult<Option<ValidationPackage>>

Trait Implementations

impl<Network: Clone> Clone for Cascade<Network>

fn clone(&self) -> Cascade<Network>

Returns a copy of the value.

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

Performs copy-assignment from source.