53 lines · 2.0 KB · Rust
RawDownload
#![deny(missing_docs, unsafe_code, rust_2018_idioms)] //! # `git_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.//!//! # 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(    feature = "document-features",    cfg_attr(doc, doc = ::document_features::document_features!()))] pub mod file; ///pub mod lookup;pub mod parse;///pub mod value;mod values;pub use values::{color, integer, path}; mod types;pub use types::{Boolean, Color, File, Integer, Path, Source};///pub mod source;