Struct RequestOutcomes 

pub struct RequestOutcomes(/* private fields */);

Every narrowing or shaping request a run RECEIVED, keyed by name.

Received, not failed: a request the run honoured is published with status: "applied", so a consumer can say “scoped to the change” positively. Read an absent object as “nothing was asked for”, never as “nothing failed”.

Absent from an envelope whenever it is empty, so a run that was asked for nothing is byte-identical to one produced before this object existed. An empty object is never emitted: it would assert that something was asked and all of it applied, which is a different and false claim.

The names this build can emit are changed-since, diff-filter and sarif-file. The reasons are git-missing, not-a-repository, git-failed and invalid-ref for changed-since, oversize, unreadable, not-utf8, foreign-namespace and ambiguous-base for diff-filter, and directory-create-failed, write-failed and serialize-failed for sarif-file. Every set is OPEN: a name a consumer does not recognise means “some request”, not an error.

sarif-file reports a SECONDARY artifact rather than the scope of the report it travels in, and it is in the same object for the same reason the others are: the run was asked to do something and did something else, and nothing in the primary report says so. Which of the two an entry is, every entry says for itself: affects is scope for the narrowing requests and artifact for this one. Select on it. A consumer that instead assumes the whole object narrows the report tells its reader an unwritten SARIF file widened the analysis, which is what affects exists to prevent.

scope_size is emitted for diff-filter only today, in added lines. A consumer reads the unit off the name, so a name that starts measuring its own scope in a later release needs no change here.

invalid-ref is reachable only through the programmatic API. The --changed-since flag validates its value before a run starts and fails with exit 2 and an error document, which is the right side to err on: a malformed ref is invalid input rather than a report of the wrong scope.

Implementations

impl RequestOutcomes

pub fn new() -> Self

An empty set, which serializes to nothing once Self::into_option has been applied.

pub fn insert(&mut self, name: RequestName, outcome: RequestOutcome)

Record one request’s outcome, replacing any previous entry for that name.

pub fn insert_if(&mut self, name: RequestName, outcome: Option<RequestOutcome>)

Record one request’s outcome when the run received it at all.

pub fn into_option(self) -> Option<Self>

Collapse an empty set to None, which is how the field stays absent on a run that was asked for nothing.

Trait Implementations

impl Clone for RequestOutcomes

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestOutcomes

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

Formats the value using the given formatter.

impl Default for RequestOutcomes

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RequestOutcomes

impl PartialEq for RequestOutcomes

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RequestOutcomes

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RequestOutcomes