gix-validate 0.12.0

Validation functions for various kinds of names in git
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Validation for various kinds of git related items.
//!
//! Errors expose a classification-only [`gix_error::ClassificationMarker`] source.
//! Use [`gix_error::classify()`] or `is_validation()` on [`gix_error::Exn`] and [`gix_error::Error`] to check the
//! classification, without depending on the concrete diagnostic type. The concrete validation
//! error remains available for downcasting and probable-cause selection.
//!
//! ## Examples
//!
//! ```
//! use bstr::ByteSlice;
//!
//! assert!(gix_validate::reference::name(b"refs/heads/main".as_bstr()).is_ok());
//! assert!(gix_validate::tag::name(b"v1.2.3".as_bstr()).is_ok());
//! assert!(gix_validate::submodule::name(b"vendor/package".as_bstr()).is_ok());
//!
//! assert!(gix_validate::path::component(b"src".as_bstr(), None, Default::default()).is_ok());
//! assert!(gix_validate::path::component(b".git".as_bstr(), None, Default::default()).is_err());
//! ```
#![deny(missing_docs)]
#![forbid(unsafe_code)]

///
pub mod reference;

///
pub mod tag;

///
pub mod submodule;

///
pub mod path;