Module splinter::admin::store[][src]

Expand description

Data store for writing and reading circuit state and pending circuit proposals.

The AdminServiceStore trait provides the public interface for storing circuits and proposals. Splinter provides the following implementations of this trait:

  • YamlAdminServiceStore - A YAML-backed store that is available by default
  • DieselAdminServiceStore - A database-backed store, powered by Diesel, that currently supports SQLite databases (with the sqlite feature) and PostgreSQL databases (with the postgres feature).

Modules

Database backend support for the AdminServiceStore, powered by Diesel.

Types for errors that can be raised while using an admin service store

Defines a YAML backed implementation of the AdminServiceStore. The goal of this implementation is to support Splinter v0.4 YAML state files.

Structs

Representation of an AdminServiceEvent defined by the admin messages

Builder to be used to build an AdminServiceEvent

Native representation of a circuit in state

Builder to be used to build a Circuit

Native representation of a node included in circuit

Builder for creating a CircutNode

Native representation of a circuit proposal

Builder to be used to build a CircuitProposal

Native representation of a circuit that is being proposed in a proposal

Builder to be used to build a ProposedCircuit which will be included in a CircuitProposal

Native representation of a node in a proposed circuit

Builder for creating a ProposedNode

Native representation of a service that is a part of a proposed circuit

Builder for creating a ProposedService

Native representation of a service that is a part of circuit

Builder for creating a Service

The unique ID of service made up of a circuit ID and the individual service ID. A service ID is only required to be unique from within a circuit.

Enums

What type of authorization the circuit requires

Predicate for filtering the lists of circuits and circuit proposals

Status of the circuit

A circuits durability requirement

Native representation of the AdminServiceEvent enum variants

A circuits message persistence strategy

Represents the of type change the circuit proposal is for

How messages are expected to be routed across a circuit

Represents a vote, either accept or reject, for a circuit proposal

Constants

Traits

Interface for performing CRUD operations on circuits, proposals, nodes, and services

Type Definitions

Return type of the admin store’s list_events_* methods.