Skip to main content

PrSummaryInput

Struct PrSummaryInput 

Source
pub struct PrSummaryInput<'a> {
    pub command: &'a str,
    pub provider: CiProvider,
    pub marker_id: String,
    pub scope: PrSummaryScope,
    pub areas: &'a [PrSummaryArea],
    pub findings: &'a [PrSummaryFinding],
    pub max_findings: usize,
    pub details_url: Option<&'a str>,
    pub layout: PrCommentLayout,
    pub status_note: Option<&'a str>,
    pub trailing_section: Option<&'a str>,
}
Expand description

Inputs for render_pr_summary.

Fields§

§command: &'a str

Fallow command the summary reports on, e.g. audit.

§provider: CiProvider

CI provider whose comment conventions apply.

§marker_id: String

Identity token embedded as an HTML marker so reruns update the same sticky comment instead of posting a new one.

§scope: PrSummaryScope

Analysis scope reported in the header.

§areas: &'a [PrSummaryArea]

Area rows for the summary table.

§findings: &'a [PrSummaryFinding]

Findings eligible for the top-findings list.

§max_findings: usize

Maximum findings to render; clamped to at least 1.

§details_url: Option<&'a str>

Link to the full report, when hosted output exists.

§layout: PrCommentLayout

Body layout variant.

§status_note: Option<&'a str>

The status note, rendered as one blockquote line under the callout. The caller joins it with the same function as the saved render, so both bodies state the same clauses in the same order.

§trailing_section: Option<&'a str>

A Markdown section after the findings and before the footer, in every layout. The CLI uses it for the unmatched config patterns.

Auto Trait Implementations§

§

impl<'a> Freeze for PrSummaryInput<'a>

§

impl<'a> RefUnwindSafe for PrSummaryInput<'a>

§

impl<'a> Send for PrSummaryInput<'a>

§

impl<'a> Sync for PrSummaryInput<'a>

§

impl<'a> Unpin for PrSummaryInput<'a>

§

impl<'a> UnsafeUnpin for PrSummaryInput<'a>

§

impl<'a> UnwindSafe for PrSummaryInput<'a>

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<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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