dotfiles_core/
lib.rs

1// Copyright (c) 2021-2022 Miguel Barreto and others
2//
3// Permission is hereby granted, free of charge, to any person obtaining
4// a copy of this software and associated documentation files (the
5// "Software"), to deal in the Software without restriction, including
6// without limitation the rights to use, copy, modify, merge, publish,
7// distribute, sublicense, and/or sell copies of the Software, and to
8// permit persons to whom the Software is furnished to do so, subject to
9// the following conditions:
10//
11// The above copyright notice and this permission notice shall be
12// included in all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22#![warn(missing_docs)]
23#![deny(rustdoc::broken_intra_doc_links)]
24#![feature(map_try_insert)]
25
26//! The core of Dotfiles-rs is basically a set of [directives](
27//! directive::Directive) that can build executable [actions](action::Action)
28//! from configuration sources (StrictYaml is the only supported configuration source
29//! so far).
30//!
31//! Directives are responsible for parsing configuration from the configuration
32//! source, applying default [settings] if necessary, and
33//! using these to build actions that can be executed.
34//!
35//! The base traits and classes for these building blocks can be found in the
36//! [action] and [directive] modules. The [yaml_util] module is a set of helper
37//! functions for Directives to parse configuration.
38pub mod action;
39pub mod directive;
40pub mod error;
41pub mod exec_wrapper;
42pub mod path;
43pub mod settings;
44pub mod yaml_util;
45
46pub use action::Action;
47pub use directive::Directive;
48pub use settings::Setting;
49pub use settings::Settings;
dotfiles_core/lib.rs

dotfiles_core/
lib.rs
