The file_system types, Label & Path, are overengineered. It's more natural to use the Path and PathBuf types provided by the std library. This replaces any mention of Label with String and any use of the old Path with either std::path::Path or std::path::PathBuf, depending on what kind of ownwership is needed. Anywhere a "root" directory is needed `PathBuf::new()` is used, i.e. an empty `PathBuf`. Otherwise `Path::new` can used to pass directory, or in fact a &str can also be used since it implements AsRef<Path>. The `File` and `Directory` types also contain there relative paths, which can be retrieved while traversing the Tree. Note the special file name `"special/faux\\path"` requires the use of an escaping string construction, i.e. `r"special/faux\\path"`. Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
radicle-git
The home for all Git utilities related to Radicle. While the majority of the utilities will attempt to be general, there may be more opinionated parts that are geared towards Radicle.
Motivation
The git2 and gitoxide libraries provide low-level APIs for interacting with git repositories and the git protocol. This family of crates attempts to provide a higher-level wrapper around those to provide a more useful API for the Radicle protocol and UI clients building on top of the protocol.
Overview
The repository is defined as a series of crates:
git-ext-- provides higher-level types over common types found ingit2.git-ref-format-- provides a higher-level API for constructing git. reference paths. Prefer this overgit-ext'sRefLikeandRefspecPattern.git-trailers-- provides a way to parse and construct git trailers.git-types-- provides higher-level types, e.g.Namespace,Reference,Remote, etc.link-git-- provides a higher-level API for git'srefdb,odb, and the git protocol.macros-- provides macros for thegit-extreferences types.std-ext-- provides some utilities extending the standard library.test-- a shim crate that refers depends on all other, individual test crates.
Tests
Please refer to test/README.md for understanding how our tests are organised.
Contribute
Please read CONTRIBUTING.md for a guide on contributing to this repository.
Credits
Thanks to the previous maintainers of the radicle-link repository,
Kim, Alex, and Fintan, for providing the foundation to work upon -- as
well as the contributors.