Struct LocalClient 

pub struct LocalClient;

A (mostly) non-operational implementation of RestApiClient.

This is primarily meant for use in local contexts (or in unsupported CI platforms/contexts) because the following methods silently do nothing:

• Self::post_thread_comment
• Self::cull_pr_reviews
• Self::post_pr_review
• Self::set_user_agent

However, Self::get_list_of_changed_files does use the git CLI to get a list of changed files.

Instantiate with Default::default().

use git_bot_feedback::client::LocalClient;

let client = LocalClient::default();

Trait Implementations

impl Clone for LocalClient

fn clone(&self) -> LocalClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalClient

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

Formats the value using the given formatter.

impl Default for LocalClient

fn default() -> LocalClient

Returns the “default value” for a type.

impl PartialEq for LocalClient

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RestApiClient for LocalClient

fn get_list_of_changed_files<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, file_filter: &'life1 FileFilter, lines_changed_only: &'life2 LinesChangedOnly, base_diff: Option<String>, ignore_index: bool, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, FileDiffLines>, ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on crate feature file-changes only.

A way to get the list of changed files in the context of the CI event.

fn is_pr_event(&self) -> bool

Is the current CI event trigger a Pull Request?

fn set_user_agent(&mut self, _user_agent: &str) -> Result<(), ClientError>

Set the user agent for the underlying HTTP request client.

fn post_thread_comment<'life0, 'async_trait>( &'life0 self, _options: ThreadCommentOptions, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A way to post feedback to the Git server’s GUI.

fn cull_pr_reviews<'life0, 'life1, 'async_trait>( &'life0 mut self, _options: &'life1 mut ReviewOptions, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resolve outdated PR review comments and remove duplicate/reused comments.

fn post_pr_review<'life0, 'life1, 'async_trait>( &'life0 mut self, _options: &'life1 ReviewOptions, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Post a PR review based on the given options.

fn write_output_variables( &self, vars: &[OutputVariable], ) -> Result<(), ClientError>

Sets the given vars as output variables.

fn start_log_group(&self, name: &str)

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

fn end_log_group(&self, name: &str)

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

fn is_debug_enabled(&self) -> bool

Is debug mode enabled?

fn event_name(&self) -> Option<String>

Get the name of the current CI event.

fn append_step_summary(&self, comment: &str) -> Result<(), RestClientError>

Appends a given comment to the CI workflow’s summary page.

fn write_file_annotations( &self, annotations: &[FileAnnotation], ) -> Result<(), RestClientError>

Sets the given annotations as file annotations.

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

Construct a HTTP request to be sent.

fn send_api_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, client: &'life1 Client, request: Request, rate_limit_headers: &'life2 RestApiRateLimitHeaders, ) -> Pin<Box<dyn Future<Output = Result<Response, RestClientError>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

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

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

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

fn log_response<'life0, 'life1, 'async_trait>( &'life0 self, response: Response, context: &'life1 str, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A helper function to log the response of an API request with context.

impl Eq for LocalClient

impl StructuralPartialEq for LocalClient