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
use std::ops::{Deref, DerefMut};
use crate::{bstr::BStr, types::AttributeStack, Repository};
/// Lifecycle
impl<'repo> AttributeStack<'repo> {
/// Create a new instance from a `repo` and the underlying pre-configured `stack`.
///
/// Note that this type is typically created by [`Repository::attributes()`] or [`Repository::attributes_only()`].
pub fn new(stack: gix_worktree::Stack, repo: &'repo Repository) -> Self {
AttributeStack { repo, inner: stack }
}
/// Detach the repository and return the underlying plumbing datatype.
pub fn detach(self) -> gix_worktree::Stack {
self.inner
}
}
impl Deref for AttributeStack<'_> {
type Target = gix_worktree::Stack;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl DerefMut for AttributeStack<'_> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.inner
}
}
/// Platform retrieval
impl<'repo> AttributeStack<'repo> {
/// Append the `relative` path to the root directory of the cache and load all attribute or ignore files on the way as needed.
/// Use `mode` to specify what kind of item lives at `relative` - directories may match against rules specifically.
/// If `mode` is `None`, the item at `relative` is assumed to be a file.
///
/// The returned platform may be used to access the actual attribute or ignore information.
#[doc(alias = "is_path_ignored", alias = "git2")]
pub fn at_path(
&mut self,
relative: impl AsRef<std::path::Path>,
mode: Option<gix_index::entry::Mode>,
) -> std::io::Result<gix_worktree::stack::Platform<'_>> {
self.inner.at_path(relative, mode, &self.repo.objects)
}
/// Obtain a platform for attribute or ignore lookups from a repo-`relative` path, typically obtained from an index entry.
/// `mode` should reflect whether it's a directory or not, or left at `None` if unknown.
///
/// If `relative` ends with `/` and `mode` is `None`, it is automatically assumed to be a directory.
pub fn at_entry<'r>(
&mut self,
relative: impl Into<&'r BStr>,
mode: Option<gix_index::entry::Mode>,
) -> std::io::Result<gix_worktree::stack::Platform<'_>> {
self.inner.at_entry(relative, mode, &self.repo.objects)
}
}