Struct AttributeStack

Source

pub struct AttributeStack<'repo> {
    pub repo: &'repo Repository,
    /* private fields */
}

Available on crate features excludes or attributes only.

Expand description

A utility to access .gitattributes and .gitignore information efficiently.

Fields§

§repo: &'repo Repository

The owning repository.

Implementations§

Source §

impl<'repo> AttributeStack<'repo>

Lifecycle

Source

pub fn new(stack: Stack, repo: &'repo Repository) -> Self

Available on crate feature excludes only.

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().

Source

pub fn detach(self) -> Stack

Available on crate feature excludes only.

Detach the repository and return the underlying plumbing datatype.

Source §

impl AttributeStack<'_>

Platform retrieval

Source

pub fn at_path( &mut self, relative: impl AsRef<Path>, mode: Option<Mode>, ) -> Result<Platform<'_>>

Available on crate feature excludes only.

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.

Source

pub fn at_entry( &mut self, relative: impl ToNormalPathComponents, mode: Option<Mode>, ) -> Result<Platform<'_>>

Available on crate feature excludes only.

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.

Methods from Deref<Target = Stack>§

Source

pub fn at_path( &mut self, relative: impl ToNormalPathComponents, mode: Option<Mode>, objects: &dyn Find, ) -> Result<Platform<'_>, Error>

Available on crate feature excludes only.

Append the relative path to the root directory of the cache and efficiently create leading directories, while assuring that no symlinks are in that path. Unless mode is known with Some(gix_index::entry::Mode::DIR|COMMIT), then relative points to a directory itself in which case the entire resulting path is created as directory. If it’s not known it is assumed to be a file. objects maybe used to lookup objects from an id mapping, with mappnigs

Provide access to cached information for that relative path via the returned platform.

Source

pub fn at_entry<'r>( &mut self, relative: impl Into<&'r BStr>, mode: Option<Mode>, objects: &dyn Find, ) -> Result<Platform<'_>, Error>

Available on crate feature excludes only.

Obtain a platform for lookups from a repo-relative path, typically obtained from an index entry. mode should reflect the kind of item set here, or left at None if unknown. objects maybe used to lookup objects from an id mapping. All effects are similar to at_path().

If relative ends with / and mode is None, it is automatically assumed set to be a directory.

Source