gix-filter 0.29.0

A crate of the gitoxide project implementing git filters
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
94
95
96

///
pub mod convert_to_git;
pub use convert_to_git::function::convert_to_git;

///
pub mod convert_to_worktree;
pub use convert_to_worktree::convert_to_worktree;

mod utils;

/// The kind of end of lines to set.
///
/// The default is implemented to be the native line ending for the current platform.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum Mode {
    /// Equivalent to `git` (`\n`) line-endings.
    Lf,
    /// Equivalent to `windows` (`\r\n`) line-endings.
    CrLf,
}

/// Possible states for the `core.autocrlf`.
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
pub enum AutoCrlf {
    /// The same as if the `text eol=lf` attribute is set.
    Input,
    /// The same as if the `text eol=crlf` attribute is set.
    Enabled,
    /// No conversion is performed.
    #[default]
    Disabled,
}

/// The combination of `crlf`, `text` and `eol` attributes into one neat package.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum AttributesDigest {
    /// Equivalent to the `-text` attribute.
    Binary,
    /// Equivalent to the `text` attribute.
    Text,
    /// Equivalent to the `text eol=lf` attributes.
    TextInput,
    /// Equivalent to the `text eol=crlf` attributes.
    TextCrlf,
    /// Equivalent to the `text=auto` attributes.
    TextAuto,
    /// Equivalent to the `text=auto eol=crlf` attributes.
    TextAutoCrlf,
    /// Equivalent to the `text=auto eol=lf` attributes.
    TextAutoInput,
}

impl From<Mode> for AttributesDigest {
    fn from(value: Mode) -> Self {
        match value {
            Mode::Lf => AttributesDigest::TextInput,
            Mode::CrLf => AttributesDigest::TextCrlf,
        }
    }
}

impl From<AutoCrlf> for AttributesDigest {
    fn from(value: AutoCrlf) -> Self {
        match value {
            AutoCrlf::Input => AttributesDigest::TextAutoInput,
            AutoCrlf::Enabled => AttributesDigest::TextAutoCrlf,
            AutoCrlf::Disabled => AttributesDigest::Binary,
        }
    }
}

/// Git Configuration that affects how CRLF conversions are applied.
#[derive(Default, Debug, Copy, Clone)]
pub struct Configuration {
    /// Corresponds to `core.autocrlf`.
    pub auto_crlf: AutoCrlf,
    /// Corresponds to `core.eol`, and is `None` if unset or set to `native`, or `Some(<mode>)` respectively.
    pub eol: Option<Mode>,
}

/// Statistics about a buffer that helps to safely perform EOL conversions
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Stats {
    /// The amount of null bytes.
    pub null: usize,
    /// The amount of lone carriage returns (`\r`).
    pub lone_cr: usize,
    /// The amount of lone line feeds (`\n`).
    pub lone_lf: usize,
    /// The amount carriage returns followed by line feeds
    pub crlf: usize,
    /// The estimate of printable characters.
    pub printable: usize,
    /// The estimate of characters that can't be printed.
    pub non_printable: usize,
}