Skip to main content

Configer

Struct Configer 

Source
pub struct Configer {
    pub filer: Filer,
    pub human: bool,
}
Expand description

Habitat Config File

Supports four serializations: HJSON, JSON, MGPK (MsgPack), and CBOR The serialization is determined by the file extension .fext which may be either ‘.json’, ‘.mgpk’, or ‘.cbor’. The default is that .json extension uses HJSON because HJSON can get (load) a strict json file. To use strict json on put (dump) then set .human to false.

Fields§

§filer: Filer§human: bool

Implementations§

Source§

impl Configer

Source

pub fn new( name: Option<String>, base: Option<String>, temp: Option<bool>, head_dir_path: Option<PathBuf>, perm: Option<u32>, reopen: Option<bool>, clear: Option<bool>, reuse: Option<bool>, clean: Option<bool>, filed: Option<bool>, extensioned: Option<bool>, mode: Option<String>, fext: Option<String>, human: Option<bool>, ) -> Result<Self, HioError>

Setup config file at path

Parameters: name: directory path name differentiator directory/file When system employs more than one keri installation, name allows differentiating each instance by name base: optional directory path segment inserted before name that allows further differentiation with a hierarchy. “” means optional. temp: assign to .temp true then open in temporary directory, clear on close Otherwise then open persistent directory, do not clear on close head_dir_path: optional head directory pathname for main database perm: optional numeric os dir permissions for database directory and database files reopen: true means (re)opened by this init, false means not (re)opened by this init but later clear: true means remove directory upon close if reopen, false means do not remove directory upon close if reopen reuse: true means reuse self.path if already exists, false means do not reuse but remake self.path clean: true means path uses clean tail variant, false means path uses normal tail variant filed: true means .path is file path not directory path, false means .path is directory path not file path mode: File open mode when filed default non-truncate r+w fext: File extension when filed human: true means use human friendly HJSON when fext is json

Source

pub fn put<T: Serialize>( &mut self, data: &T, human: Option<bool>, ) -> Result<bool, HioError>

Serialize data dict and write to file given by path where serialization is given by fext path’s extension of either JSON, MsgPack, or CBOR for extension .json, .mgpk, or .cbor respectively

Parameters: data: to be serialized per file extension on path human: override for human-friendly JSON formatting

Raises: HioError if unsupported file extension or file not opened

Source

pub fn get<T>(&mut self, human: Option<bool>) -> Result<T, HioError>
where T: for<'de> Deserialize<'de> + Default,

Returns data converted from contents of file path given extension Returns empty/default value if empty file

Raises: HioError if unsupported file extension or file not opened

File may be either json, msgpack, or cbor given by extension .json, .mgpk, or .cbor respectively

Source

pub fn close(&mut self, clear: bool) -> Result<bool, HioError>

Close the configer

Source

pub fn reopen( &mut self, temp: Option<bool>, head_dir_path: Option<PathBuf>, perm: Option<u32>, clear: bool, reuse: bool, clean: bool, mode: Option<String>, fext: Option<String>, ) -> Result<bool, HioError>

Reopen the configer

Source

pub fn exists( &self, name: &str, base: &str, head_dir_path: Option<&Path>, clean: bool, filed: bool, extensioned: bool, fext: Option<&str>, ) -> Result<bool, HioError>

Check if config exists

Trait Implementations§

Source§

impl Debug for Configer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Deref for Configer

Source§

type Target = Filer

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for Configer

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more