Struct Document 

pub struct Document {
    pub key: String,
    pub payload: Value,
    pub state: Option<String>,
    pub updated_at: Option<String>,
    pub complete: bool,
    pub fetched_at: String,
}

One document, as GitHub last described it.

Fields

key: String

What identifies it inside its scope: an issue number, a gist id, a tag name, a project item id.

payload: Value

state: Option<String>

updated_at: Option<String>

complete: bool

Whether the payload is the whole thing rather than a list summary.

fetched_at: String

Implementations

impl Document

pub fn of(key: impl Into<String>, payload: Value) -> Self

One document from a value GitHub sent, with the columns a query needs pulled out of it.

The extraction is by field NAME, which is the same name in every kind GitHub returns — state and updated_at. A kind that carries neither stores neither, and is read back whole.

pub fn summary(key: impl Into<String>, payload: Value) -> Self

The same, for a payload that is a summary rather than the whole thing.

pub fn with_state(self, state: impl Into<String>) -> Self

The same, with a state this kind does not carry in its payload.

Trait Implementations

impl Clone for Document

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 Document

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

Formats the value using the given formatter.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document