gitignores 4.8.6

GitHub’s collection of gitignores, embedded, automatically updated
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

/// Common methods for all gitignore collection enums
///
/// You can also use this trait to accept any gitignore type:
///
/// ```
/// use std::path::Path;
/// use gitignores::GitIgnore;
/// fn ignored(file: impl AsRef<Path>, gitignore: impl GitIgnore) -> bool { false }
/// ```
pub trait GitIgnore {
	/// The contents of the gitignore
	///
	/// Returns an empty string if the `no-contents` feature is enabled.
	fn contents(self) -> &'static str;

	/// The file name of the gitignore
	fn file_name(self) -> &'static str;

	/// The full path of the gitignore relative to repo root
	fn file_path(self) -> &'static str;

	/// The list of all included gitignores, by their variant names
	#[cfg(feature = "std")]
	fn list() -> Vec<&'static str>;

	/// Retrieve a gitignore dynamically, by its variant name
	fn get(variant: &'static str) -> Option<Self>
	where
		Self: Sized;
}