Skip to content

Commit

Permalink
Add some more metadata.
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnavion committed Apr 5, 2024
1 parent 257864e commit 3665359
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ authors = ["Arnav Singh <[email protected]>"]
edition = "2021"
categories = ["config"]
description = "Rust implementation of the UAPI Configuration Files Specification"
documentation = "https://docs.rs/uapi-config/0.1.0/"
keywords = ["econf", "libeconf", "systemd", "uapi"]
readme = "README.md"
repository = "https://github.com/Arnavion/uapi-config"
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Rust implementation of [the UAPI Configuration Files Specification.](https://uapi-group.org/specifications/specs/configuration_files_specification/)

[crates.io](https://crates.io/crates/uapi-config)

[Documentation](https://docs.rs/uapi-config/)

[Changelog](https://github.com/Arnavion/uapi-config/blob/main/CHANGELOG.md)


# What about [`libeconf`](https://github.com/openSUSE/libeconf) ?

Expand Down
8 changes: 7 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ impl<'a> SearchDirectories<'a> {

/// Append the directory for local user config overrides, `$XDG_CONFIG_HOME`.
///
/// If the `dirs` crate feature is enabled, then `dirs::config_dir()` is used for the implementation of `$XDG_CONFIG_HOME`.
/// If the `dirs` crate feature is enabled, then `dirs::config_dir()` is used for the implementation of `$XDG_CONFIG_HOME`,
/// else a custom implementation is used.
#[must_use]
pub fn with_user_directory(mut self) -> Self {
Expand Down Expand Up @@ -209,6 +209,8 @@ impl std::fmt::Display for InvalidPathError {
impl std::error::Error for InvalidPathError {}

/// A list of search directories that the config files will be searched under, scoped to a particular project.
///
/// Created using [`SearchDirectories::with_project`].
#[derive(Clone, Debug)]
pub struct SearchDirectoriesForProject<'a, TProject> {
inner: Vec<Cow<'a, Path>>,
Expand Down Expand Up @@ -324,6 +326,8 @@ impl<'a, TProject> SearchDirectoriesForProject<'a, TProject> {
}

/// A list of search directories that the config files will be searched under, scoped to a particular config file name.
///
/// Created using [`SearchDirectories::with_file_name`].
#[derive(Clone, Debug)]
pub struct SearchDirectoriesForFileName<'a, TFileName> {
inner: Vec<Cow<'a, Path>>,
Expand Down Expand Up @@ -440,6 +444,8 @@ impl<'a, TFileName> SearchDirectoriesForFileName<'a, TFileName> {
}

/// A list of search directories that the config files will be searched under, scoped to a particular project and config file name.
///
/// Created using [`SearchDirectoriesForProject::with_file_name`] or [`SearchDirectoriesForFileName::with_project`].
#[derive(Clone, Debug)]
pub struct SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName> {
inner: Vec<Cow<'a, Path>>,
Expand Down

0 comments on commit 3665359

Please sign in to comment.