Struct splinter::registry::LocalYamlRegistry

pub struct LocalYamlRegistry { /* fields omitted */ }

A local, read/write registry.

The LocalYamlRegistry provides access to and modification of a local registry YAML file. The local registry file must be a YAML sequence of nodes, where each node is valid (see Node for validity criteria).

The contents of the YAML file are cached in-memory by the registry; this means that the registry will continue to be available even if the backing YAML file becomes unavailable. Each time the registry is read, it will check the backing file for any changes since the last read and refresh the internal cache if necessary.

On initializaion, the registry will check if its backing file already exists. If the backing file already exists, the registry will attempt to load, parse, and validate it. If the backing file does not already exist, the registry will attempt to create it.

Implementations

impl LocalYamlRegistry

pub fn new(file_path: &str) -> Result<LocalYamlRegistry, RegistryError>

Construct a new LocalYamlRegistry. If the backing file already exists, it will be loaded, parsed, and validated; if any of these steps fails, the error will be returned. If the backing file doesn’t already exist, it will be created and initialized; if file creation fails, the error will be returned.

Arguments

• file_path - The path of the backing YAML file.

Trait Implementations

impl Clone for LocalYamlRegistry

fn clone(&self) -> LocalYamlRegistry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl RegistryReader for LocalYamlRegistry

fn get_node(&self, identity: &str) -> Result<Option<Node>, RegistryError>

Returns the node with the given identity, if it exists in the registry.

fn list_nodes<'a, 'b: 'a>(
    &'b self,
    predicates: &'a [MetadataPredicate]
) -> Result<NodeIter<'a>, RegistryError>

Returns an iterator over the nodes in the registry.

fn count_nodes(
    &self,
    predicates: &[MetadataPredicate]
) -> Result<u32, RegistryError>

Returns the count of nodes in the registry.

fn has_node(&self, identity: &str) -> Result<bool, RegistryError>

Determines whether or not the node exists in the registry.

impl RegistryWriter for LocalYamlRegistry

fn add_node(&self, node: Node) -> Result<(), RegistryError>

Adds a new node to the registry.

fn update_node(&self, node: Node) -> Result<(), RegistryError>

Replaces an existing node with the same identity.

fn delete_node(&self, identity: &str) -> Result<Option<Node>, RegistryError>

Deletes a node with the given identity and returns the node if it was in the registry.

impl RwRegistry for LocalYamlRegistry

fn clone_box(&self) -> Box<dyn RwRegistry>

Clone implementation for RwRegistry. The implementation of the Clone trait for Box<RwRegistry> calls this method.

fn clone_box_as_reader(&self) -> Box<dyn RegistryReader>

Clone the RwRegistry as a Box<dyn RegistryReader>.

fn clone_box_as_writer(&self) -> Box<dyn RegistryWriter>

Clone the RwRegistry as a Box<dyn RegistryWriter>.