Skip to main content

ReviewComments

cpp_linter::clang_tools

Struct ReviewComments 

Source 
pub struct ReviewComments {
    pub tool_total: u32,
    pub comments: Vec<Suggestion>,
    pub full_patch: String,
}
Expand description

A struct to describe the Pull Request review suggestions.

Fields§

§tool_total: u32

The total count of suggestions from clang-tidy and clang-format.

This differs from comments.len() because some suggestions may not fit within the file’s diff.

§comments: Vec<Suggestion>

A list of comment suggestions to be posted.

These suggestions are guaranteed to fit in the file’s diff.

§full_patch: String

The complete patch of changes to all files scanned.

This includes changes from both clang-tidy and clang-format (assembled in that order).

Implementations§

Source§

impl ReviewComments

Source

pub fn summarize( &self, clang_versions: &ClangVersions, comments: &[ReviewComment], total_review_comments: u32, summary_only: bool, ) -> String

Get a markdown-formatted string that summarizes the given ReviewComments.

The total_review_comments parameter describes the number of comments before removing duplicates found in previous reviews.

Source

pub fn is_comment_in_suggestions(&mut self, comment: &Suggestion) -> bool

Check if a given comment’s Suggestion is already contained within the existing Self::comments.

Trait Implementations§

Source§

impl Default for ReviewComments

Source§

fn default() -> ReviewComments

Returns the “default value” for a type. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = 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