holochain_state 0.3.1

Holochain persisted state datatypes and functions
docs.rs failed to build holochain_state-0.3.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: holochain_state-0.4.0-dev.14

holochain_state

Project Forum Chat

Twitter Follow

Crate API Docs

The Holochain state crate provides helpers and abstractions for working with the holochain_sqlite crate.

Reads

The main abstraction for creating data read queries is the Query trait. This can be implemented to make constructing complex queries easier.

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 is the complete set of functions for writing data to sqlite in holochain.

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.

The Query trait allows combining arbitrary database SQL queries with the scratch space so reads can union across the database and in-memory data.

License

License: CAL 1.0

Copyright (C) 2019 - 2024, Holochain Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.