Struct GithubApiClient

pub struct GithubApiClient {
    pub event_name: String,
    pub debug_enabled: bool,
    /* private fields */
}

A structure to work with Github REST API.

Fields

event_name: String

The name of the event that was triggered when running cpp_linter.

debug_enabled: bool

The value of the ACTIONS_STEP_DEBUG environment variable.

Implementations

impl GithubApiClient

pub fn new() -> Result<Self>

Instantiate a GithubApiClient object.

pub fn post_step_summary(&self, comment: &String)

Append step summary to CI workflow’s summary page.

pub fn post_annotations(&self, files: &[Arc<Mutex<FileObj>>], style: &str)

Post file annotations.

pub async fn update_comment( &self, url: Url, comment: &String, no_lgtm: bool, is_lgtm: bool, update_only: bool, ) -> Result<()>

Update existing comment or remove old comment(s) and post a new comment

pub async fn post_review( &self, files: &[Arc<Mutex<FileObj>>], feedback_input: &FeedbackInput, clang_versions: &ClangVersions, ) -> Result<()>

Post a PR review with code suggestions.

Note: --no-lgtm is applied when nothing is suggested.

Trait Implementations

impl RestApiClient for GithubApiClient

fn start_log_group(&self, name: String)

This prints a line to indicate the beginning of a related group of log statements.

fn end_log_group(&self)

This prints a line to indicate the ending of a related group of log statements.

fn set_exit_code( &self, checks_failed: u64, format_checks_failed: Option<u64>, tidy_checks_failed: Option<u64>, ) -> u64

A way to set output variables specific to cpp_linter executions in CI.

fn make_headers() -> Result<HeaderMap<HeaderValue>>

A convenience method to create the headers attached to all REST API calls.

async fn get_list_of_changed_files( &self, file_filter: &FileFilter, ) -> Result<Vec<FileObj>>

A way to get the list of changed files using REST API calls. It is this method’s job to parse diff blobs and return a list of changed files.

async fn get_changed_files_paginated( &self, url: Url, file_filter: &FileFilter, ) -> Result<Vec<FileObj>>

A way to get the list of changed files using REST API calls that employ a paginated response.

async fn post_feedback( &self, files: &[Arc<Mutex<FileObj>>], feedback_inputs: FeedbackInput, clang_versions: ClangVersions, ) -> Result<u64>

A way to post feedback in the form of thread_comments, file_annotations, and step_summary.

fn make_api_request( client: &Client, url: impl IntoUrl, method: Method, data: Option<String>, headers: Option<HeaderMap>, ) -> Result<Request>

Construct a HTTP request to be sent.

fn send_api_request( client: Client, request: Request, rate_limit_headers: RestApiRateLimitHeaders, retries: u8, ) -> impl Future<Output = Result<Response>> + Send

A convenience function to send HTTP requests and respect a REST API rate limits.

fn make_comment( &self, files: &[Arc<Mutex<FileObj>>], format_checks_failed: u64, tidy_checks_failed: u64, clang_versions: &ClangVersions, max_len: Option<u64>, ) -> String

Makes a comment in MarkDown syntax based on the concerns in format_advice and tidy_advice about the given set of files.

fn try_next_page(headers: &HeaderMap) -> Option<Url>

Gets the URL for the next page in a paginated response.

fn log_response( response: Response, context: &str, ) -> impl Future<Output = ()> + Send