holochain_state 0.8.0-dev.2

Holochain persisted state datatypes and functions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35


# holochain_state

[![Project](https://img.shields.io/badge/project-holochain-blue.svg?style=flat-square)](http://holochain.org/)
[![Discord](https://img.shields.io/badge/Discord-blue.svg?style=flat-square)](https://discord.gg/k55DS5dmPH)
[![Twitter Follow](https://img.shields.io/twitter/follow/holochain.svg?style=social&label=Follow)](https://twitter.com/holochain)

[![Crate](https://img.shields.io/crates/v/holochain_state.svg)](https://crates.io/crates/holochain_state)
[![API Docs](https://docs.rs/holochain_state/badge.svg)](https://docs.rs/holochain_state)

<!-- cargo-rdme start -->

The Holochain state crate provides helpers and abstractions for working
with Holochain's persistent data stores.

### Reads
The [`DhtStore`] and [`DhtStoreRead`] types are the main abstractions for
reading data, combining database access with the in-memory scratch space.

The [`source_chain`] module provides the `SourceChain` type,
which is the abstraction for working with chains of actions.

The [`host_fn_workspace`] module provides abstractions for reading data during workflows.

### Writes
The [`mutations`] module provides error types for state write operations.

### In-memory
The [`scratch`] module provides the `Scratch` type for
reading and writing data in memory that is not visible anywhere else.

The SourceChain type uses the Scratch for in-memory operations which
can be flushed to the database.

<!-- cargo-rdme end -->