Scroll to navigation

kdb::tools(3elektra) Elektra kdb::tools(3elektra)

NAME

kdb::tools - This namespace is for the libtool library.

SYNOPSIS

Classes


class Backend
A low-level representation of the backend (= set of plugins) that can be mounted. class BackendBuilder
Highlevel interface to build a backend. class BackendBuilderInit
Used as argument of constructor of *BackendBuilder. class BackendFactory
Factory for MountBackendInterface. struct BackendInfo
Info about a backend. class BackendInterface
Minimal interface to add plugins. class Backends
Allows one to list backends. class ErrorPlugins
Plugins to handle errors during configuration access. class GetPlugins
Plugins to get configuration. class GlobalPlugins
Low level representation of global plugins. class GlobalPluginsBuilder
Build global plugins. class ImportExportBackend
Backend for import/export functionality. class MockPluginDatabase
A plugin database that works with added fake data. class Modules
Allows one to load plugins. class ModulesPluginDatabase
A plugin database that works with installed modules. class MountBackendBuilder
High-level functionality to build a mountpoint. class MountBackendInterface
Interface to work with mountpoints (backends) for factory. class Plugin
This is a C++ representation of a plugin. class PluginAdder
Adds plugins in a generic map. class PluginDatabase
Loads all plugins and allows us to query them. class Plugins
A collection of plugins (either get, set or error) class PluginSpec
Specifies a plugin by its name and configuration. struct PluginSpecHash
Only to be used with PluginSpecName! class SerializeInterface
Interface to serialize a backend. class SetPlugins
Plugins to set configuration. class SpecBackendBuilder
Build individual backend while reading specification. class SpecReader
Highlevel interface to build a backend from specification. struct ToolException
All exceptions from the elektratools library are derived from this exception.

Functions


std::ostream & operator<< (std::ostream &os, Backend const &b)
Prints the current status. kdb::KeySet parsePluginArguments (std::string const &pluginArguments, std::string const &basepath)
Parse a string containing information to create a KeySet. PluginSpecVector parseArguments (std::string const &cmdline)
Parse a complete commandline. template<typename Iterator > PluginSpecVector parseArguments (Iterator first, Iterator last)
Parse a complete commandline that is already tokenized in pluginname pluginconfig. std::ostream & operator<< (std::ostream &os, PluginSpec const &spec)
Output the name, refname and size of config. bool operator== (PluginSpec const &self, PluginSpec const &other)
Compare two pluginspec if their value is equal. bool operator!= (PluginSpec const &self, PluginSpec const &other)
Compare two pluginspec if their value is not equal.

Detailed Description

This namespace is for the libtool library.

Note:

You have to link against libelektratools if you want to use functionality from it. Contrary to classes in namespace kdb it is not header-only.

See also:

Backend for an entry point

Function Documentation

bool kdb::tools::operator!= (PluginSpec const & self, PluginSpec const & other)

Compare two pluginspec if their value is not equal.

Note:

the content of getConfig() will be only compared with keynames, not content!

std::ostream & kdb::tools::operator<< (std::ostream & os, Backend const & b)

Prints the current status.

Parameters:

os stream to print to
b backend to get status from

Returns:

ref to stream

bool kdb::tools::operator== (PluginSpec const & self, PluginSpec const & other)

Compare two pluginspec if their value is equal.

Note:

the content of getConfig() will be only compared with keynames, not content!

PluginSpecVector kdb::tools::parseArguments (std::string const & cmdline)

Parse a complete commandline.

Parameters:

cmdline contains space separated plugins with optional plugin configurations

Note:

currently whitespaces are not allowed within pluginname or config, use iterator interface parseArguments() if you need it.

See also:

parseArguments()

Returns:

a parsed PluginSpecVector

template<typename Iterator > PluginSpecVector kdb::tools::parseArguments (Iterator first, Iterator last)

Parse a complete commandline that is already tokenized in pluginname pluginconfig.

Template Parameters:

Iterator forward iterator type

Parameters:

cmdline contains space separated plugins with optional plugin configurations

Returns:

a parsed PluginSpecVector

KeySet kdb::tools::parsePluginArguments (std::string const & pluginArguments, std::string const & basepath)

Parse a string containing information to create a KeySet.

Parameters:

pluginArguments comma (,) to separate key=value, contains no whitespaces

Returns:

newly created keyset with the information found in the string

Author

Generated automatically by Doxygen for Elektra from the source code.

Mon Jan 15 2018 Version 0.8.20