gix_validate/
reference.rsuse bstr::{BStr, BString, ByteSlice};
pub mod name {
use std::convert::Infallible;
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("A reference must be a valid tag name as well")]
Tag(#[from] crate::tag::name::Error),
#[error("Standalone references must be all uppercased, like 'HEAD'")]
SomeLowercase,
}
impl From<Infallible> for Error {
fn from(_: Infallible) -> Self {
unreachable!("this impl is needed to allow passing a known valid partial path as parameter")
}
}
}
pub fn name(path: &BStr) -> Result<&BStr, name::Error> {
match validate(path, Mode::Complete)? {
None => Ok(path),
Some(_) => {
unreachable!("Without sanitization, there is no chance a sanitized version is returned.")
}
}
}
pub fn name_partial(path: &BStr) -> Result<&BStr, name::Error> {
match validate(path, Mode::Partial)? {
None => Ok(path),
Some(_) => {
unreachable!("Without sanitization, there is no chance a sanitized version is returned.")
}
}
}
pub fn name_partial_or_sanitize(path: &BStr) -> BString {
validate(path, Mode::PartialSanitize)
.expect("BUG: errors cannot happen as any issue is fixed instantly")
.expect("we always rebuild the path")
}
enum Mode {
Complete,
Partial,
PartialSanitize,
}
fn validate(path: &BStr, mode: Mode) -> Result<Option<BString>, name::Error> {
let out = crate::tag::name_inner(
path,
match mode {
Mode::Complete | Mode::Partial => crate::tag::Mode::Validate,
Mode::PartialSanitize => crate::tag::Mode::Sanitize,
},
)?;
if let Mode::Complete = mode {
let input = out.as_ref().map_or(path, |b| b.as_bstr());
let saw_slash = input.find_byte(b'/').is_some();
if !saw_slash && !input.iter().all(|c| c.is_ascii_uppercase() || *c == b'_') {
return Err(name::Error::SomeLowercase);
}
}
Ok(out)
}