gix_validate/lib.rs
1//! Validation for various kinds of git related items.
2//!
3//! ## Examples
4//!
5//! ```
6//! use bstr::ByteSlice;
7//!
8//! assert!(gix_validate::reference::name(b"refs/heads/main".as_bstr()).is_ok());
9//! assert!(gix_validate::tag::name(b"v1.2.3".as_bstr()).is_ok());
10//! assert!(gix_validate::submodule::name(b"vendor/package".as_bstr()).is_ok());
11//!
12//! assert!(gix_validate::path::component(b"src".as_bstr(), None, Default::default()).is_ok());
13//! assert!(gix_validate::path::component(b".git".as_bstr(), None, Default::default()).is_err());
14//! ```
15#![deny(missing_docs, rust_2018_idioms)]
16#![forbid(unsafe_code)]
17
18///
19pub mod reference;
20
21///
22pub mod tag;
23
24///
25pub mod submodule;
26
27///
28pub mod path;