Struct git_attributes::PatternList

pub struct PatternList<T: Pattern> {
    pub patterns: Vec<PatternMapping<T::Value>>,
    pub source: Option<PathBuf>,
    pub base: Option<BString>,
}

A list of patterns which optionally know where they were loaded from and what their base is.

Knowing their base which is relative to a source directory, it will ignore all path to match against that don’t also start with said base.

Fields

patterns: Vec<PatternMapping<T::Value>>

Patterns and their associated data in the order they were loaded in or specified, the line number in its source file or its sequence number ((pattern, value, line_number)).

During matching, this order is reversed.

source: Option<PathBuf>

The path from which the patterns were read, or None if the patterns don’t originate in a file on disk.

base: Option<BString>

The parent directory of source, or None if the patterns are global to match against the repository root. It’s processed to contain slashes only and to end with a trailing slash, and is relative to the repository root.

Implementations

impl<T> PatternList<T>where
    T: Pattern,

pub fn from_bytes(
    bytes: &[u8],
    source: impl Into<PathBuf>,
    root: Option<&Path>
) -> Self

source is the location of the bytes which represent a list of patterns line by line.

Examples found in repository

src/match_group.rs (line 192)

    pub fn add_patterns_buffer(&mut self, bytes: &[u8], source: impl Into<PathBuf>, root: Option<&Path>) {
        self.patterns
            .push(PatternList::<Ignore>::from_bytes(bytes, source.into(), root));
    }
}

fn read_in_full_ignore_missing(path: &Path, follow_symlinks: bool, buf: &mut Vec<u8>) -> std::io::Result<bool> {
    buf.clear();
    let file = if follow_symlinks {
        std::fs::File::open(path)
    } else {
        git_features::fs::open_options_no_follow().read(true).open(path)
    };
    Ok(match file {
        Ok(mut file) => {
            file.read_to_end(buf)?;
            true
        }
        Err(err) if err.kind() == std::io::ErrorKind::NotFound => false,
        Err(err) => return Err(err),
    })
}

impl<T> PatternList<T>
where
    T: Pattern,
{
    /// `source` is the location of the `bytes` which represent a list of patterns line by line.
    pub fn from_bytes(bytes: &[u8], source: impl Into<PathBuf>, root: Option<&Path>) -> Self {
        let source = source.into();
        let patterns = T::bytes_to_patterns(bytes);

        let base = root
            .and_then(|root| source.parent().expect("file").strip_prefix(root).ok())
            .and_then(|base| {
                (!base.as_os_str().is_empty()).then(|| {
                    let mut base: BString =
                        git_path::to_unix_separators_on_windows(git_path::into_bstr(base)).into_owned();

                    base.push_byte(b'/');
                    base
                })
            });
        PatternList {
            patterns,
            source: Some(source),
            base,
        }
    }

    /// Create a pattern list from the `source` file, which may be located underneath `root`, while optionally
    /// following symlinks with `follow_symlinks`, providing `buf` to temporarily store the data contained in the file.
    pub fn from_file(
        source: impl Into<PathBuf>,
        root: Option<&Path>,
        follow_symlinks: bool,
        buf: &mut Vec<u8>,
    ) -> std::io::Result<Option<Self>> {
        let source = source.into();
        Ok(read_in_full_ignore_missing(&source, follow_symlinks, buf)?.then(|| Self::from_bytes(buf, source, root)))
    }

pub fn from_file(
    source: impl Into<PathBuf>,
    root: Option<&Path>,
    follow_symlinks: bool,
    buf: &mut Vec<u8>
) -> Result<Option<Self>>

Create a pattern list from the source file, which may be located underneath root, while optionally following symlinks with follow_symlinks, providing buf to temporarily store the data contained in the file.

Examples found in repository

src/match_group.rs (line 149)

    pub fn from_git_dir(
        git_dir: impl AsRef<Path>,
        excludes_file: Option<PathBuf>,
        buf: &mut Vec<u8>,
    ) -> std::io::Result<Self> {
        let mut group = Self::default();

        let follow_symlinks = true;
        // order matters! More important ones first.
        group.patterns.extend(
            excludes_file
                .map(|file| PatternList::<Ignore>::from_file(file, None, follow_symlinks, buf))
                .transpose()?
                .flatten(),
        );
        group.patterns.extend(PatternList::<Ignore>::from_file(
            git_dir.as_ref().join("info").join("exclude"),
            None,
            follow_symlinks,
            buf,
        )?);
        Ok(group)
    }

    /// See [PatternList::<Ignore>::from_overrides()] for details.
    pub fn from_overrides(patterns: impl IntoIterator<Item = impl Into<OsString>>) -> Self {
        MatchGroup {
            patterns: vec![PatternList::<Ignore>::from_overrides(patterns)],
        }
    }

    /// Add the given file at `source` if it exists, otherwise do nothing. If a `root` is provided, it's not considered a global file anymore.
    /// Returns true if the file was added, or false if it didn't exist.
    pub fn add_patterns_file(
        &mut self,
        source: impl Into<PathBuf>,
        follow_symlinks: bool,
        root: Option<&Path>,
        buf: &mut Vec<u8>,
    ) -> std::io::Result<bool> {
        let previous_len = self.patterns.len();
        self.patterns.extend(PatternList::<Ignore>::from_file(
            source.into(),
            root,
            follow_symlinks,
            buf,
        )?);
        Ok(self.patterns.len() != previous_len)
    }

impl<T> PatternList<T>where
    T: Pattern,

pub fn pattern_matching_relative_path(
    &self,
    relative_path: &BStr,
    basename_pos: Option<usize>,
    is_dir: Option<bool>,
    case: Case
) -> Option<Match<'_, T::Value>>

Return a match if a pattern matches relative_path, providing a pre-computed basename_pos which is the starting position of the basename of relative_path. is_dir is true if relative_path is a directory. case specifies whether cases should be folded during matching or not.

Examples found in repository

src/match_group.rs (line 130)

    pub fn pattern_matching_relative_path<'a>(
        &self,
        relative_path: impl Into<&'a BStr>,
        is_dir: Option<bool>,
        case: git_glob::pattern::Case,
    ) -> Option<Match<'_, T::Value>> {
        let relative_path = relative_path.into();
        let basename_pos = relative_path.rfind(b"/").map(|p| p + 1);
        self.patterns
            .iter()
            .rev()
            .find_map(|pl| pl.pattern_matching_relative_path(relative_path, basename_pos, is_dir, case))
    }

pub fn pattern_idx_matching_relative_path(
    &self,
    relative_path: &BStr,
    basename_pos: Option<usize>,
    is_dir: Option<bool>,
    case: Case
) -> Option<usize>

Like pattern_matching_relative_path(), but returns an index to the pattern that matched relative_path, instead of the match itself.

impl PatternList<Ignore>

pub fn from_overrides(
    patterns: impl IntoIterator<Item = impl Into<OsString>>
) -> Self

Parse a list of patterns, using slashes as path separators

Examples found in repository

src/match_group.rs (line 165)

    pub fn from_overrides(patterns: impl IntoIterator<Item = impl Into<OsString>>) -> Self {
        MatchGroup {
            patterns: vec![PatternList::<Ignore>::from_overrides(patterns)],
        }
    }

Trait Implementations

impl<T: Clone + Pattern> Clone for PatternList<T>where
    T::Value: Clone,

fn clone(&self) -> PatternList<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Pattern> Debug for PatternList<T>where
    T::Value: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default + Pattern> Default for PatternList<T>where
    T::Value: Default,

fn default() -> PatternList<T>

Returns the “default value” for a type.

impl<T: Hash + Pattern> Hash for PatternList<T>where
    T::Value: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + Pattern> Ord for PatternList<T>where
    T::Value: Ord,

fn cmp(&self, other: &PatternList<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq + Pattern> PartialEq<PatternList<T>> for PatternList<T>where
    T::Value: PartialEq,

fn eq(&self, other: &PatternList<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + Pattern> PartialOrd<PatternList<T>> for PatternList<T>where
    T::Value: PartialOrd,

fn partial_cmp(&self, other: &PatternList<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + Pattern> Eq for PatternList<T>where
    T::Value: Eq,

impl<T: Pattern> StructuralEq for PatternList<T>

impl<T: Pattern> StructuralPartialEq for PatternList<T>