Skip to main content

GitHubProjectsConfig

Struct GitHubProjectsConfig 

Source
pub struct GitHubProjectsConfig {
    pub owner: String,
    pub project_number: u32,
    pub repository: Option<String>,
    pub token_env: String,
    pub endpoint: String,
    pub status_mapping: BTreeMap<String, Option<StatusTargetConfig>>,
    pub pacing: PacingConfig,
}
Expand description

Configuration for one GitHub Projects v2 board.

Fields§

§owner: String

Login of the user or organization which owns the board.

§project_number: u32

The project number shown in the board’s GitHub URL.

§repository: Option<String>

owner/name of the repository this source creates an issue in when the item’s own repositories field does not decide it.

An item naming exactly one repository is created there; a task or a document naming none or several is created in its parent project’s repository; and a project, or a task or document with no parent, naming none or several is created here. A board has no repository of its own and createIssue requires one, so a write without this is refused naming the field. Reads never need it.

§token_env: String

Environment variable containing a fine-grained token with Projects and Issues read/write plus Pull requests read-only access for every repository represented on the board.

§endpoint: String

GraphQL endpoint. GitHub Enterprise installations may override it.

§status_mapping: BTreeMap<String, Option<StatusTargetConfig>>

Per-instance mapping from a status category to where it lands on this board.

A category this does not mention keeps its shipped default: backlog to “Backlog”, todo to “Todo”, queued to “Queued”, in-progress to “In Progress”, done to “Done” plus closed as completed, cancelled to “Cancelled” plus closed as not planned, and draft and unknown disabled. unknown may name one existing board option; every unknown word then lands on that option and reads back as unknown under its name. Unlike local-md, this source cannot keep each unknown word because it never creates board options.

§pacing: PacingConfig

How fast this source writes, and how long it waits out a rate-limit refusal.

Every field keeps its shipped default when it is absent, and the defaults are GitHub’s own published limits rather than taste. See [Pacing].

Trait Implementations§

Source§

impl Clone for GitHubProjectsConfig

Source§

fn clone(&self) -> GitHubProjectsConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GitHubProjectsConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GitHubProjectsConfig

Source§

fn default() -> GitHubProjectsConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GitHubProjectsConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for GitHubProjectsConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more