Struct gix::AttributeStack

source ·

pub struct AttributeStack<'repo> { /* private fields */ }

Available on (crate features excludes or attributes) and (crate features attributes or excludes) only.

Expand description

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

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<'repo> AttributeStack<'repo>

Platform retrieval

source

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

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 is_dir is known with Some(…), 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.

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>, is_dir: Option<bool> ) -> Result<Platform<'_>>

Available on crate feature excludes only.

Obtain a platform for lookups from a repo-relative path, typically obtained from an index entry. is_dir should reflect whether it’s a directory or not, or left at None if unknown.

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

Panics

on illformed UTF8 in relative

Methods from Deref<Target = Stack>§

source

pub fn at_path<Find, E>( &mut self, relative: impl AsRef<Path>, is_dir: Option<bool>, find: Find ) -> Result<Platform<'_>, Error>where Find: for<'a> FnMut(&oid, &'a mut Vec<u8, Global>) -> Result<BlobRef<'a>, E>, E: Error + Send + Sync + 'static,

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 is_dir is known with Some(…), 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. find 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, Find, E>( &mut self, relative: impl Into<&'r BStr>, is_dir: Option<bool>, find: Find ) -> Result<Platform<'_>, Error>where Find: for<'a> FnMut(&oid, &'a mut Vec<u8, Global>) -> Result<BlobRef<'a>, E>, E: Error + Send + Sync + 'static,

Available on crate feature excludes only.

Obtain a platform for lookups from a repo-relative path, typically obtained from an index entry. is_dir should reflect whether it’s a directory or not, or left at None if unknown. find maybe used to lookup objects from an id mapping. All effects are similar to at_path().

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