Enum DeclarationSource 

pub enum DeclarationSource {
    Declared {
        document: PathBuf,
        declared: Declaration,
    },
    Undeclared {
        looked_in: PathBuf,
    },
    Unreadable {
        reason: String,
    },
}

What a repository’s own declaration said, or why this build has no answer from it.

Three states, and the third is why this is a value rather than an Option<Declaration>: a declaration this build could not read is not a repository that declares nothing. A consumer waiting on a release holds indefinitely on the first and acts on the second, so collapsing them here would be the “not answered is not not released” mistake made one layer up.

Variants

Declared

The repository declares what it publishes, and this build read it.

Fields

document: PathBuf

The document it was read from.

declared: Declaration

What that document declares.

Undeclared

The repository carries no declaration: nothing in it says what it publishes, so this host’s own document is the whole answer.

Fields

looked_in: PathBuf

The checkout that was looked in.

Unreadable

What this repository declares is unknown — there is nowhere to read a declaration from, or the one that is there is not a declaration this build can read.

Never “it declares nothing”: whatever targets are answered alongside this may be fewer than the repository publishes.

Fields

reason: String

Why it could not be read, in the words the reader refused it with.

Implementations

impl DeclarationSource

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

How this state is spelled in a rendering and in the JSON document.

pub fn declared(&self) -> Option<&Declaration>

What the repository declares, where this build read a declaration.

pub fn unreadable(&self) -> Option<&str>

Why what this repository publishes is unknown, where it is.

A caller that has to say “there may be more targets than these” asks this, and gets None for both states in which the answer is complete.

Trait Implementations

impl Clone for DeclarationSource

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 DeclarationSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeclarationSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DeclarationSource

impl PartialEq for DeclarationSource

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DeclarationSource

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 DeclarationSource