Struct config_it::storage::Storage

pub struct Storage { /* private fields */ }

Storage manages multiple sets registered by preset key.

Implementations

impl Storage

pub fn new() -> (Self, impl Future<Output = ()>)

👎Deprecated: Use global function ‘create’ instead

Creates new storage and its driver.

The second tuple parameter is asynchronous loop which handles all storage events, which must be spawned or blocked by runtime to make storage work. All storage

pub fn close(&self) -> Result<(), Error>

pub async fn find_or_create<T>( &self, path: impl IntoIterator<Item = impl ToCompactString> ) -> Result<Group<T>, ConfigError>where T: Template,

Tries to find existing group from path name, and if it doesn’t exist, tries to create new

pub async fn find<'a, T: Template>( &self, path: impl IntoIterator<Item = &'a impl AsRef<str> + ?Sized + 'a> ) -> Result<Group<T>, GroupFindError>

A shortcut for find_group_ex

pub async fn create<T>( &self, path: impl IntoIterator<Item = impl ToCompactString> ) -> Result<Group<T>, ConfigError>where T: Template,

pub async fn export(&self, option: ExportOptions) -> Result<Archive, Error>

Dump all configs from storage.

Arguments

• no_merge - If true, only active archive contents will be collected. Otherwise, result will contain merge result of previously loaded archive.
• no_update - If true, existing archive won’t

pub async fn import( &self, archive: Archive, option: ImportOptions ) -> Result<(), Error>

Deserializes data

Arguments

• de - Deserializer
• merge - True if loaded archive should merge onto existing one. Otherwise, it’ll replace currently loaded archive data.

Data serialization rule:

• The first path component is root component, which is written as-is.
• Any path component after the first must be prefixed with ~(tilde) character.
  • Otherwise, they are treated as field element of enclosing path component.
• Any ‘~’ prefixed key inside of existing field

{
    "root_path": {
        "~path_component": {
            "field_name": "value",
            "other_field": {
                "~this_is_not_treated_as_path"
            }
        },
        "~another_path_component": {},
        "field_name_of_root_path": "yay"
    },
    "another_root_path": {}
}

pub async fn fence(&self)

Wait synchronization after calling ‘import’

pub async fn monitor_open_replication_channel( &self ) -> Result<ReplicationChannel, Error>

Create replication channel

pub async fn monitor_send_event(&self, evt: MonitorEvent) -> Result<(), Error>

Send monitor event to storage driver.

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a copy of the value.

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

Performs copy-assignment from source.