Struct holochain_cascade::Cascade

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

The Cascade is a multi-tiered accessor for Holochain DHT data.

See the module-level docs for more info.

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_db: 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_and_network<N, AuthorDb, DhtDb>(
    workspace: &HostFnWorkspace<AuthorDb, DhtDb>,
    network: N
) -> Cascade<N>where
    N: HolochainP2pDnaT + Clone,
    AuthorDb: ReadAccess<DbKindAuthored>,
    DhtDb: ReadAccess<DbKindDht>,

Construct a Cascade with network access

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

Construct a Cascade with local-only access to the provided stores

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

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

Fetch a Record from the network, caching and returning the results

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_action(
    &mut self,
    hash: ActionHash,
    options: NetworkGetOptions
) -> CascadeResult<Option<SignedActionHashed>>

Retrieve [SignedActionHashed] 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<Record>>

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>>

Get Entry data along with all CRUD actions associated with it.

Also returns Rejected actions, which may affect the interpreted validity status of this Entry.

pub async fn get_record_details(
    &mut self,
    action_hash: ActionHash,
    options: GetOptions
) -> CascadeResult<Option<RecordDetails>>

Get the specified Record along with all Updates and Deletes associated with it.

Can return a Rejected Record.

pub async fn dht_get_action(
    &mut self,
    action_hash: ActionHash,
    options: GetOptions
) -> CascadeResult<Option<Record>>

Returns the [Record] for this ActionHash if it is live by getting the latest available metadata from authorities combined with this agents authored data. Note: Deleted actions are a tombstone set

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

Returns the oldest live [Record] 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<Record>>>

Perform a concurrent get on multiple hashes simultaneously, returning the resulting list of Records in the order that they come in (NOT the order in which they were requested!).

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

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>>

Get either EntryDetails or RecordDetails, depending on the hash provided

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<(SignedActionHashed, Vec<SignedActionHashed>)>>

Return all CreateLink actions and DeleteLink actions ordered by time.

pub async fn must_get_agent_activity(
    &mut self,
    author: AgentPubKey,
    filter: ChainFilter
) -> CascadeResult<MustGetAgentActivityResponse>

Request a hash bounded chain query.

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

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_actions will fetch the valid actions in parallel (requires include_valid_activity) Query:
• include_entries will also fetch the entries in parallel (requires include_full_actions)
• sequence_range will get all the activity in the exclusive range
• action_type and entry_type will filter the activity (requires include_full_actions)

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.