hegel::Database Class Reference

Configure the Hegel database. More...

#include <settings.h>

Public Types
enum class	Kind { Unset , Disabled , Path }
	The configuration of the database. See the methods below. More...

Static Public Member Functions
static Database	unset ()
static Database	disabled ()
static Database	from_path (std::string path)

Detailed Description

Configure the Hegel database.

Member Enumeration Documentation

Kind

enum class hegel::Database::Kind

strong

The configuration of the database. See the methods below.

Enumerator
Unset	Default behavior. By default, Hegel places the database at .hegel.
Disabled	Disable the database.
Path	Use the given directory as the database.

Member Function Documentation

disabled()

Database hegel::Database::disabled ( )

inlinestatic

Disable the database.

Returns

A database with Database.Kind.Disabled.

from_path()

Database hegel::Database::from_path ( std::string path )

inlinestatic

Use the given directory as the database.

Parameters

path	The directory path for the database.

Returns

A database with Database.Kind.Path.

unset()

Database hegel::Database::unset ( )

inlinestatic

Default behavior. By default, Hegel places the database at .hegel.

Returns

A database with Database.Kind.Unset.

---

The documentation for this class was generated from the following file:

• include/hegel/settings.h