blob: 7dd7e89c9e1a8ae1b49c9635c87607be55b1f5f0 [file] [log] [blame] [edit]
//! Parsing for data types used in `git-config` files to allow their use from environment variables and other sources.
//!
//! ## Feature Flags
#![cfg_attr(
all(doc, feature = "document-features"),
doc = ::document_features::document_features!()
)]
#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
/// The error returned when any config value couldn't be instantiated due to malformed input.
#[derive(Debug, thiserror::Error, Eq, PartialEq)]
#[allow(missing_docs)]
#[error("Could not decode '{input}': {message}")]
pub struct Error {
pub message: &'static str,
pub input: bstr::BString,
#[source]
pub utf8_err: Option<std::str::Utf8Error>,
}
impl Error {
/// Create a new value error from `message`, with `input` being what's causing the error.
pub fn new(message: &'static str, input: impl Into<bstr::BString>) -> Self {
Error {
message,
input: input.into(),
utf8_err: None,
}
}
pub(crate) fn with_err(mut self, err: std::str::Utf8Error) -> Self {
self.utf8_err = Some(err);
self
}
}
mod boolean;
///
#[allow(clippy::empty_docs)]
pub mod color;
///
#[allow(clippy::empty_docs)]
pub mod integer;
///
#[allow(clippy::empty_docs)]
pub mod path;
mod types;
pub use types::{Boolean, Color, Integer, Path};