#[non_exhaustive]pub struct CodeReview {Show 16 fields
pub name: Option<String>,
pub code_review_arn: Option<String>,
pub repository_name: Option<String>,
pub owner: Option<String>,
pub provider_type: Option<ProviderType>,
pub state: Option<JobState>,
pub state_reason: Option<String>,
pub created_time_stamp: Option<DateTime>,
pub last_updated_time_stamp: Option<DateTime>,
pub type: Option<Type>,
pub pull_request_id: Option<String>,
pub source_code_type: Option<SourceCodeType>,
pub association_arn: Option<String>,
pub metrics: Option<Metrics>,
pub analysis_types: Option<Vec<AnalysisType>>,
pub config_file_state: Option<ConfigFileState>,
}Expand description
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: Option<String>The name of the code review.
code_review_arn: Option<String>The Amazon Resource Name (ARN) of the CodeReview object.
repository_name: Option<String>The name of the repository.
owner: Option<String>The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
provider_type: Option<ProviderType>The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
state: Option<JobState>The valid code review states are:
-
Completed: The code review is complete. -
Pending: The code review started and has not completed or failed. -
Failed: The code review failed. -
Deleting: The code review is being deleted.
state_reason: Option<String>The reason for the state of the code review.
created_time_stamp: Option<DateTime>The time, in milliseconds since the epoch, when the code review was created.
last_updated_time_stamp: Option<DateTime>The time, in milliseconds since the epoch, when the code review was last updated.
type: Option<Type>The type of code review.
pull_request_id: Option<String>The pull request ID for the code review.
source_code_type: Option<SourceCodeType>The type of the source code for the code review.
association_arn: Option<String>The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
metrics: Option<Metrics>The statistics from the code review.
analysis_types: Option<Vec<AnalysisType>>The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
config_file_state: Option<ConfigFileState>The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.
Implementations§
Source§impl CodeReview
impl CodeReview
Sourcepub fn code_review_arn(&self) -> Option<&str>
pub fn code_review_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the CodeReview object.
Sourcepub fn repository_name(&self) -> Option<&str>
pub fn repository_name(&self) -> Option<&str>
The name of the repository.
Sourcepub fn owner(&self) -> Option<&str>
pub fn owner(&self) -> Option<&str>
The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
Sourcepub fn provider_type(&self) -> Option<&ProviderType>
pub fn provider_type(&self) -> Option<&ProviderType>
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
Sourcepub fn state(&self) -> Option<&JobState>
pub fn state(&self) -> Option<&JobState>
The valid code review states are:
-
Completed: The code review is complete. -
Pending: The code review started and has not completed or failed. -
Failed: The code review failed. -
Deleting: The code review is being deleted.
Sourcepub fn state_reason(&self) -> Option<&str>
pub fn state_reason(&self) -> Option<&str>
The reason for the state of the code review.
Sourcepub fn created_time_stamp(&self) -> Option<&DateTime>
pub fn created_time_stamp(&self) -> Option<&DateTime>
The time, in milliseconds since the epoch, when the code review was created.
Sourcepub fn last_updated_time_stamp(&self) -> Option<&DateTime>
pub fn last_updated_time_stamp(&self) -> Option<&DateTime>
The time, in milliseconds since the epoch, when the code review was last updated.
Sourcepub fn pull_request_id(&self) -> Option<&str>
pub fn pull_request_id(&self) -> Option<&str>
The pull request ID for the code review.
Sourcepub fn source_code_type(&self) -> Option<&SourceCodeType>
pub fn source_code_type(&self) -> Option<&SourceCodeType>
The type of the source code for the code review.
Sourcepub fn association_arn(&self) -> Option<&str>
pub fn association_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
Sourcepub fn analysis_types(&self) -> &[AnalysisType]
pub fn analysis_types(&self) -> &[AnalysisType]
The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .analysis_types.is_none().
Sourcepub fn config_file_state(&self) -> Option<&ConfigFileState>
pub fn config_file_state(&self) -> Option<&ConfigFileState>
The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.
Source§impl CodeReview
impl CodeReview
Sourcepub fn builder() -> CodeReviewBuilder
pub fn builder() -> CodeReviewBuilder
Creates a new builder-style object to manufacture CodeReview.
Trait Implementations§
Source§impl Clone for CodeReview
impl Clone for CodeReview
Source§fn clone(&self) -> CodeReview
fn clone(&self) -> CodeReview
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CodeReview
impl Debug for CodeReview
Source§impl PartialEq for CodeReview
impl PartialEq for CodeReview
impl StructuralPartialEq for CodeReview
Auto Trait Implementations§
impl Freeze for CodeReview
impl RefUnwindSafe for CodeReview
impl Send for CodeReview
impl Sync for CodeReview
impl Unpin for CodeReview
impl UnwindSafe for CodeReview
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);