Enum LintScope 

pub enum LintScope {
    SourceRepository,
    Package,
    BuildInfo,
    PackageBuild,
    PackageInfo,
    SourceInfo,
}

The possible scope used to categorize lint rules.

Scopes are used to determine what lints should be executed based on a specific linting operation. For example, selecting LintScope::SourceInfo will run all SourceInfo specific linting rules. Linting scopes can also be fully enabled or disabled via configuration files.

Variants

SourceRepository

Lint rules with this scope are specific to an alpm-source-repo.

Such lint rules check the consistency of an Arch Linux package source repository. This includes the consistency of data between several metadata files.

When this scope is selected, the following lint scopes are implied:

• LintScope::PackageBuild
• LintScope::SourceInfo

Package

Lint rules with this scope are specific to an alpm-package.

Such lint rules check the consistency of an Arch Linux package file. This includes the consistency of data between various metadata files.

When this scope is selected, the following lint scopes are implied:

• LintScope::PackageInfo
• LintScope::BuildInfo

BuildInfo

Lint rules with this scope are specific to a single BUILDINFO file.

PackageBuild

Lint rules with this scope are specific to a single PKGBUILD file.

PackageInfo

Lint rules with this scope are specific to a single PKGINFO file.

SourceInfo

Lint rules with this scope are specific to a single SRCINFO file.

Implementations

impl LintScope

pub fn contains(&self, other: &LintScope) -> bool

Determines whether a LintScope contains or matches another.

In this context “contains” and “matches” means that either self is identical to other, or that the scope of other is contained in the scope of self.

Examples

use alpm_lint::LintScope;

let source_info = LintScope::SourceInfo;
let source_repo = LintScope::SourceRepository;

assert!(source_repo.contains(&source_info));
assert!(source_info.contains(&source_info));
assert!(!source_info.contains(&source_repo));

pub fn detect(path: &Path) -> Result<LintScope, Error>

Attempts to return all applicable lint scopes based on a provided path.

Usually, when calling alpm-lint check, LintScope::detect is used to automatically determine the available linting scope based on files in the specified directory. The current scope can also be overridden by the user.

Based on that scope, files will be loaded and linting rules are selected for execution.

Errors

• The path cannot be read/accessed
• The scope cannot be determined based on the file/s at the given path.

pub fn is_single_file(&self) -> bool

Checks whether the LintScope is for a single file.

Trait Implementations

impl Clone for LintScope

fn clone(&self) -> LintScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LintScope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LintScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LintScope

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

Formats the value using the given formatter.

impl PartialEq for LintScope

fn eq(&self, other: &LintScope) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for LintScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueEnum for LintScope

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl VariantArray for LintScope

const VARIANTS: &'static [Self]

impl Copy for LintScope

impl StructuralPartialEq for LintScope