Struct splinter::registry::UnifiedRegistry

pub struct UnifiedRegistry { /* fields omitted */ }

A registry with multiple sources.

The UnifiedRegistry provides a unified view of multiple source registries. It has one internal read-write registry and an arbitrary number of external read-only registries.

Writing

All write operations (provided by the implementation of the RegistryWriter trait) affect only the internal read-write registry.

Reading

Read operations (provided by the RegistryReader implementation) provide Node data from all source registries.

If a Node exists in more than one registry (nodes are considered duplicates if they have the same identity), then the definition of the Node from the registry with the highest precedence is used, with the exception of the node’s metadata (see the Metadata Merging section below).

If reading a source registry fails, the error will be logged and the registry will be ignored.

Registry Precedence

The internal read-write registry has the highest precedence, followed by the read-only registries. The precedence of the read-only registries is based on the order they appear (the earlier in the list, the higher the priority).

Metadata Merging

When the same node exists in multiple registries, the metadata is merged from all sources. If the same metadata key is set for the node in different registires, the value for that key from the highest-precedence registry will be used.

Implementations

impl UnifiedRegistry

pub fn new(
    internal_source: Box<dyn RwRegistry>,
    external_sources: Vec<Box<dyn RegistryReader>>
) -> Self

Constructs a new UnifiedRegistry with an internal read-write registry and an arbitrary number of read-only registries.

Trait Implementations

impl Clone for UnifiedRegistry

fn clone(&self) -> UnifiedRegistry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl RegistryReader for UnifiedRegistry

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 get_node(&self, identity: &str) -> Result<Option<Node>, RegistryError>

Returns the node with the given identity, if it exists 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 UnifiedRegistry

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 UnifiedRegistry

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>.