gix-utils 0.3.6

A crate with `gitoxide` utilities that don't need feature toggles
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use std::borrow::Cow;

use ::bstr::{BStr, BString};

/// Provide a borrowed byte-string view of common string and byte containers.
///
/// Unlike [`AsRef`], this conversion deliberately bridges representations such
/// as [`String`] and [`Vec<u8>`] to [`BStr`] without allocating.
pub trait AsBStr {
    /// Return this value as a borrowed byte string.
    fn as_bstr(&self) -> &BStr;
}

/// Provide an optional borrowed byte-string view of common string and byte containers.
pub trait AsBStrOpt {
    /// Return this value as a borrowed byte string, or `None` if it is absent.
    fn as_bstr_opt(&self) -> Option<&BStr>;
}

impl<T: AsBStr + ?Sized> AsBStrOpt for T {
    fn as_bstr_opt(&self) -> Option<&BStr> {
        Some(self.as_bstr())
    }
}

impl AsBStrOpt for Option<&BStr> {
    fn as_bstr_opt(&self) -> Option<&BStr> {
        *self
    }
}

impl<T: AsBStr + ?Sized> AsBStr for &T {
    fn as_bstr(&self) -> &BStr {
        T::as_bstr(self)
    }
}

impl<T: AsBStr + ?Sized> AsBStr for &mut T {
    fn as_bstr(&self) -> &BStr {
        T::as_bstr(self)
    }
}

impl AsBStr for BStr {
    fn as_bstr(&self) -> &BStr {
        self
    }
}

impl AsBStr for BString {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self.as_slice())
    }
}

impl AsBStr for str {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self)
    }
}

impl AsBStr for String {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self)
    }
}

impl AsBStr for [u8] {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self)
    }
}

impl AsBStr for Vec<u8> {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self)
    }
}

impl<const N: usize> AsBStr for [u8; N] {
    fn as_bstr(&self) -> &BStr {
        BStr::new(self)
    }
}

impl<T> AsBStr for Cow<'_, T>
where
    T: AsBStr + ToOwned + ?Sized,
{
    fn as_bstr(&self) -> &BStr {
        self.as_ref().as_bstr()
    }
}