Struct holochain_state::scratch::Scratch

pub struct Scratch { /* private fields */ }

The “scratch” is an in-memory space to stage Actions to be committed at the end of the CallZome workflow.

This space must also be queryable: specifically, it needs to be combined into queries into the database which return Actions. This is done by a simple filter on the scratch space, and then chaining that iterator onto the iterators over the Actions in the database(s) produced by the Cascade.

Implementations

impl Scratch

pub fn new() -> Self

pub fn scheduled_fns(&self) -> &[ScheduledFn]

pub fn add_scheduled_fn(&mut self, scheduled_fn: ScheduledFn)

pub fn chain_top_ordering(&self) -> ChainTopOrdering

pub fn respect_chain_top_ordering(
    &mut self,
    chain_top_ordering: ChainTopOrdering
)

pub fn add_action(
    &mut self,
    item: SignedActionHashed,
    chain_top_ordering: ChainTopOrdering
)

pub fn chain_head(&self) -> Option<(ActionHash, u32, Timestamp)>

pub fn add_entry(
    &mut self,
    entry_hashed: EntryHashed,
    chain_top_ordering: ChainTopOrdering
)

pub fn as_filter(
    &self,
    f: impl Fn(&SignedActionHashed) -> bool
) -> FilteredScratch

pub fn into_sync(self) -> SyncScratch

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn actions(&self) -> impl Iterator<Item = &SignedActionHashed>

pub fn records(&self) -> impl Iterator<Item = Record> + '_

pub fn entries(&self) -> impl Iterator<Item = (&EntryHash, &Arc<Entry>)>

Get the entries on in the scratch.

pub fn num_actions(&self) -> usize

pub fn drain_scheduled_fns(&mut self) -> impl Iterator<Item = ScheduledFn> + '_

pub fn drain_actions(&mut self) -> impl Iterator<Item = SignedActionHashed> + '_

Drain out all the actions.

pub fn drain_entries(&mut self) -> impl Iterator<Item = EntryHashed> + '_

Drain out all the entries.

Trait Implementations

impl Clone for Scratch

fn clone(&self) -> Scratch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scratch

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

Formats the value using the given formatter.

impl Default for Scratch

fn default() -> Scratch

Returns the “default value” for a type.

impl Store for Scratch

fn get_public_or_authored_entry(
    &self,
    hash: &EntryHash,
    _author: Option<&AgentPubKey>
) -> StateQueryResult<Option<Entry>>

It doesn’t make sense to search for a different authored entry in a scratch then the scratches author so this is the same as get_entry.

fn get_public_or_authored_record(
    &self,
    hash: &AnyDhtHash,
    _author: Option<&AgentPubKey>
) -> StateQueryResult<Option<Record>>

It doesn’t make sense to search for a different authored record in a scratch then the scratches author so this is the same as get_record.

fn get_entry(&self, hash: &EntryHash) -> StateQueryResult<Option<Entry>>

Get an [Entry] from this store.

fn contains_entry(&self, hash: &EntryHash) -> StateQueryResult<bool>

Check if an entry is contained in the store

fn contains_action(&self, hash: &ActionHash) -> StateQueryResult<bool>

Check if an action is contained in the store

fn get_action(
    &self,
    hash: &ActionHash
) -> StateQueryResult<Option<SignedActionHashed>>

Get an [SignedActionHashed] from this store.

fn get_record(&self, hash: &AnyDhtHash) -> StateQueryResult<Option<Record>>

Get an [Record] from this store.

fn contains_hash(&self, hash: &AnyDhtHash) -> StateQueryResult<bool>

Check if a hash is contained in the store

impl<Q> Stores<Q> for Scratch where
    Q: Query<Item = Judged<SignedActionHashed>>, 

type O = FilteredScratch

fn get_initial_data(&self, query: Q) -> StateQueryResult<Self::O>

Gets the raw initial data from the database, needed to begin the query.