Enum Reason 

#[non_exhaustive]
pub enum Reason {
    GrantedByInvocation,
    GrantedByUserLayer,
    SandboxByDefault,
    SandboxByInvocation,
    SandboxByUserLayer,
    SandboxByProjectDenial,
}

Which layer decided, and therefore what the person should be told.

Every variant carries one sentence of explanation, because a decision the person did not make is one they have to be able to account for — most of all when it overrules something they did say. --allow-unsandboxed in a repository that denies host execution runs sandboxed, and that has to be a sentence rather than a silence.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GrantedByInvocation

Host execution was granted by --allow-unsandboxed on this run.

GrantedByUserLayer

Host execution was granted by the user’s own config, with no flag needed.

SandboxByDefault

Nobody asked for anything — the default, and the common case.

SandboxByInvocation

--sandboxed was passed.

SandboxByUserLayer

The user’s own config says false, so the host is off the table.

SandboxByProjectDenial

This repository’s roteiro.toml denied host execution. Nothing overrides this, including --allow-unsandboxed.

Implementations

impl Reason

pub fn backend(self) -> Backend

Which backend this reason selects.

pub fn granted(self) -> bool

Whether the linter may run on this host.

pub fn explanation(self) -> &'static str

One sentence naming which layer decided, for the line printed before the run.

Phrased to complete “running clippy …”, so the two backends’ disclosures read alike and a person can tell at a glance which one they got.

pub fn host_escape(self) -> Option<Guidance>

How this person could run on the host instead, if the sandbox cannot be had — or None when they could not.

Consulted only by a refusal, and it exists so that a refusal names a way forward that would actually work for this reason. Telling someone in a repository that denies host execution to pass --allow-unsandboxed would waste their time, and telling someone who is already on the host how to get there would be nonsense. Both were live bugs in the shape this replaces (#426’s refusals rule).

A Guidance rather than a &'static str, because this text is multi-line and carries commands people paste. Written as one wrapped literal it leaked its own source indentation into shipped output; written as lines and fragments it cannot.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Reason

impl Debug for Reason

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

Formats the value using the given formatter.

impl Eq for Reason

impl PartialEq for Reason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reason