Skip to main content

GitHubIssues

Struct GitHubIssues 

Source
pub struct GitHubIssues { /* private fields */ }
Expand description

Tracker over the GitHub Issues REST API.

No Debug derive: kept explicit so a field added later cannot print Debug would print it wherever a log line or a panic message met the adapter.

Implementations§

Source§

impl GitHubIssues

Source

pub fn new(http: Arc<dyn HttpClient>, clock: Arc<dyn Clock>) -> Self

An adapter pointed at https://api.github.com. It holds no token: which repository, under whose installation, is tenant data and arrives with each file or status call (#453).

Source

pub fn with_base(self, base: impl Into<String>) -> Self

Points the adapter at another API root — GitHub Enterprise Server, or a fake in tests — instead of https://api.github.com.

Trait Implementations§

Source§

impl Debug for GitHubIssues

Source§

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

Holds no credential to leak: the token arrives per call (#453).

Source§

impl Tracker for GitHubIssues

Source§

fn status<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, dest: &'life1 Destination, cred: &'life2 Credential, external_id: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<TicketStatus, TrackerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

GitHub has a ticket to read back, so this is a real read: GET the issue and map what it says. state_reason distinguishes a completed close from a “not planned” one — both are terminal, so both are Closed; an open issue with an assignee is the one signal GitHub gives that somebody picked it up.

Source§

fn file<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, dest: &'life1 Destination, cred: &'life2 Credential, draft: &'life3 TicketDraft, ) -> Pin<Box<dyn Future<Output = Result<Filed, TrackerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Files draft into dest, authenticating as the company cred speaks for. Idempotent on draft.idempotency_key where the tracker allows it. Read more
Source§

fn comment<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, dest: &'life1 Destination, _cred: &'life2 Credential, _external_id: &'life3 str, _comment: &'life4 TicketComment, ) -> Pin<Box<dyn Future<Output = Result<(), TrackerError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, Self: 'async_trait,

Adds comment to the existing ticket external_id in dest — e.g. linking a duplicate report to the ticket it duplicates, so the tracker holds one ticket per defect rather than one per report. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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