Enum Scope 

pub enum Scope {
    Issues(String),
    Pulls(String),
    Checks {
        repo: String,
        commit: String,
    },
    Releases(String),
    Tags(String),
    Repository(String),
    Milestones(String),
    Labels(String),
    Traffic(String),
    Comments {
        repo: String,
        number: i64,
    },
    Gists,
    Notifications,
    RateLimit,
    Viewer,
    Projects(String),
    ProjectItems(String),
}

What one mirrored thing is called, and what a sync is about.

One vocabulary for every kind: the sync fetches, compares and records them identically, and a vocabulary per kind would mean a copy of every query that asks what is stale, what failed, or what moved.

The string form is what the database and every change notice carry, so it is part of the contract rather than a debugging convenience.

Variants

Issues(String)

One repository’s issues, as owner/repo.

Pulls(String)

One repository’s pull requests.

Checks

What CI says about one commit of one repository.

Per commit, because the same repository is checked out at different commits in different worktrees, and CI for the work in front of a person is CI for the commit that worktree is on.

Fields

repo: String

commit: String

Releases(String)

Tags(String)

Repository(String)

What the repository IS: private or public, archived, its topics, its stars.

Milestones(String)

Labels(String)

Traffic(String)

Views and clones. Needs push access, so this is the one scope whose refusal is ordinary.

Comments

Comments on one issue or pull request: owner/repo#number.

Fields

repo: String

number: i64

Gists

The authenticated user’s gists.

Notifications

What GitHub thinks needs this person, across every repository.

RateLimit

How much API budget is left.

Viewer

Who the token belongs to, and the organisations it is a member of — the owners whose boards are this person’s without anybody naming them.

Projects(String)

Which project boards one owner has.

ProjectItems(String)

One board’s cards, by the board’s node id.

Implementations

impl Scope

pub fn key(&self) -> String

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

The repository this scope is about, when it is about one.

pub fn parse(key: &str) -> Option<Self>

Read one back from what the database and a change notice carry.

Every scope round-trips, or the process that wrote a row cannot say what the row is about — see the round-trip test.

pub fn label(&self) -> String

What a person calls it, for a message about it.

pub fn is_authoritative(&self) -> bool

Whether a whole answer replaces what is held.

A LIST endpoint says what exists: a gist absent from it was deleted, a release absent from it was removed. An INCREMENTAL one says only what changed, so what it does not mention is still true — and clearing on one of those empties the mirror every time nothing happened.

Issues and pull requests are fetched with since, so they are incremental. Everything else is asked for whole.

Trait Implementations

impl Clone for Scope

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 Scope

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

Formats the value using the given formatter.

impl Eq for Scope

impl Hash for Scope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Scope

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Scope

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Scope

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Scope