Skip to main content

GitHubAt

Struct GitHubAt 

Source
pub struct GitHubAt<'a, R: ProcessRunner = JobRunner> { /* private fields */ }
Expand description

A GitHub client with a working directory bound, so its repo-scoped methods drop the leading dir argument (gh.at(dir).pr_list()). Construct one with GitHub::at.

Implementations§

Source§

impl<'a, R: ProcessRunner> GitHubAt<'a, R>

Source

pub async fn run(&self, args: &[String]) -> Result<String>

Bound form of GitHub’s run.

Source

pub async fn run_raw(&self, args: &[String]) -> Result<ProcessResult<String>>

Bound form of GitHub’s run_raw.

Source

pub async fn run_args(&self, args: &[&str]) -> Result<String>

Bound form of GitHub’s run_args.

Source

pub async fn run_raw_args(&self, args: &[&str]) -> Result<ProcessResult<String>>

Bound form of GitHub’s run_raw_args.

Source

pub async fn version(&self) -> Result<String>

Bound form of GitHub’s version.

Source

pub async fn auth_status(&self) -> Result<bool>

Bound form of GitHub’s auth_status.

Source

pub async fn api(&self, endpoint: &str) -> Result<String>

Bound form of GitHub’s api.

Source

pub async fn repo_view(&self) -> Result<Repo>

Bound form of GitHub’s repo_view (with dir pre-bound).

Source

pub async fn pr_list(&self) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list (with dir pre-bound).

Source

pub async fn pr_list_for_branch( &self, head: &str, base: &str, ) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list_for_branch (with dir pre-bound).

Source

pub async fn pr_view(&self, number: u64) -> Result<PullRequest>

Bound form of GitHub’s pr_view (with dir pre-bound).

Source

pub async fn issue_list(&self) -> Result<Vec<Issue>>

Bound form of GitHub’s issue_list (with dir pre-bound).

Source

pub async fn pr_create(&self, spec: PrCreate) -> Result<String>

Bound form of GitHub’s pr_create (with dir pre-bound).

Source

pub async fn pr_merge(&self, number: u64, merge: PrMerge) -> Result<()>

Bound form of GitHub’s pr_merge (with dir pre-bound).

Source

pub async fn pr_ready(&self, number: u64) -> Result<()>

Bound form of GitHub’s pr_ready (with dir pre-bound).

Source

pub async fn pr_close(&self, number: u64, delete_branch: bool) -> Result<()>

Bound form of GitHub’s pr_close (with dir pre-bound).

Source

pub async fn pr_checks(&self, number: u64) -> Result<Vec<CheckRun>>

Bound form of GitHub’s pr_checks (with dir pre-bound).

Source

pub async fn pr_review(&self, number: u64, action: ReviewAction) -> Result<()>

Bound form of GitHub’s pr_review (with dir pre-bound).

Source

pub async fn pr_comment(&self, number: u64, body: &str) -> Result<String>

Bound form of GitHub’s pr_comment (with dir pre-bound).

Source

pub async fn pr_feedback(&self, number: u64) -> Result<PrFeedback>

Bound form of GitHub’s pr_feedback (with dir pre-bound).

Source

pub async fn run_list( &self, limit: u64, branch: Option<String>, ) -> Result<Vec<WorkflowRun>>

Bound form of GitHub’s run_list (with dir pre-bound).

Source

pub async fn run_view(&self, id: u64) -> Result<WorkflowRun>

Bound form of GitHub’s run_view (with dir pre-bound).

Source

pub async fn run_watch(&self, id: u64) -> Result<WorkflowRun>

Bound form of GitHub’s run_watch (with dir pre-bound).

Source

pub async fn issue_create(&self, title: &str, body: &str) -> Result<String>

Bound form of GitHub’s issue_create (with dir pre-bound).

Source

pub async fn issue_view(&self, number: u64) -> Result<Issue>

Bound form of GitHub’s issue_view (with dir pre-bound).

Source

pub async fn release_list(&self) -> Result<Vec<Release>>

Bound form of GitHub’s release_list (with dir pre-bound).

Source

pub async fn release_view(&self, tag: &str) -> Result<Release>

Bound form of GitHub’s release_view (with dir pre-bound).

Trait Implementations§

Source§

impl<R: ProcessRunner> Clone for GitHubAt<'_, R>

Source§

fn clone(&self) -> Self

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<R: ProcessRunner> Copy for GitHubAt<'_, R>

Auto Trait Implementations§

§

impl<'a, R> Freeze for GitHubAt<'a, R>

§

impl<'a, R> RefUnwindSafe for GitHubAt<'a, R>
where R: RefUnwindSafe,

§

impl<'a, R> Send for GitHubAt<'a, R>

§

impl<'a, R> Sync for GitHubAt<'a, R>

§

impl<'a, R> Unpin for GitHubAt<'a, R>

§

impl<'a, R> UnsafeUnpin for GitHubAt<'a, R>

§

impl<'a, R> UnwindSafe for GitHubAt<'a, R>
where R: RefUnwindSafe,

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> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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