gix-config 0.55.0

A git-config file parser and editor from the gitoxide project
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! # `gix_config`
//!
//! This crate is a high performance `git-config` file reader and writer. It
//! exposes a high level API to parse, read, and write [`git-config` files].
//!
//! This crate has a few primary offerings and various accessory functions. The
//! table below gives a brief explanation of all offerings, loosely in order
//! from the highest to lowest abstraction.
//!
//! | Offering      | Description                                         | Zero-copy?        |
//! | ------------- | --------------------------------------------------- | ----------------- |
//! | [`File`] | Accelerated wrapper for reading and writing values. | On some reads[^1] |
//! | [`parse::State`]    | Syntactic events for `git-config` files.     | Yes               |
//! | value wrappers | Wrappers for `git-config` value types.            | Yes               |
//!
//! This crate also exposes efficient value normalization which unescapes
//! characters and removes quotes through the `normalize_*` family of functions,
//! located in the [`value`] module.
//!
//! # Examples
//!
//! ## Read And Update Values
//!
//! ```
//! use bstr::ByteSlice;
//! use std::str::FromStr;
//!
//! const SAMPLE: &str = "[core]\neditor = vim\nbare = false\n[remote \"origin\"]\nurl = https://example.com/gitoxide.git\n";
//! let mut config = gix_config::File::from_str(SAMPLE).unwrap();
//! assert_eq!(config.string_by("core", None, "editor").unwrap().as_ref(), "vim");
//! assert_eq!(config.boolean_by("core", None, "bare").unwrap().unwrap(), false);
//!
//! let previous = config.set_raw_value(&"core.editor", "nvim").unwrap().unwrap();
//! assert_eq!(previous.as_ref(), "vim");
//! assert_eq!(config.raw_value("core.editor").unwrap().as_ref(), "nvim");
//! assert!(config.to_bstring().find(b"nvim").is_some());
//! ```
//!
//! # Known differences to the `git config` specification
//!
//! - Legacy headers like `[section.subsection]` are supposed to be turned into to lower case and compared
//!   case-sensitively. We keep its case and compare case-insensitively.
//!
//! [^1]: When read values do not need normalization and it wasn't parsed in 'owned' mode.
//!
//! [`git-config` files]: https://git-scm.com/docs/git-config#_configuration_file
//! [`File`]: crate::File
//! [`parse::State`]: crate::parse::Events
//! [`nom`]: https://github.com/Geal/nom
//!
//! ## Feature Flags
#![cfg_attr(
    all(doc, feature = "document-features"),
    doc = ::document_features::document_features!()
)]
#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg))]
#![deny(missing_docs, rust_2018_idioms, unsafe_code)]

pub mod file;

///
pub mod lookup;
pub mod parse;
///
pub mod value;
pub use gix_config_value::{color, integer, path, Boolean, Color, Integer, Path};

mod key;
pub use key::{AsKey, KeyRef};
mod types;
pub use types::{File, Source};
///
pub mod source;