Skip to main content

ReviewCommentRenderInput

Struct ReviewCommentRenderInput 

Source
pub struct ReviewCommentRenderInput<'a, 'group> {
    pub provider: CiProvider,
    pub group: &'a [&'group CiIssue],
    pub gitlab_diff_refs: Option<&'a ReviewGitlabDiffRefs>,
    pub diff_index: Option<&'a DiffIndex>,
    pub path_prefix: &'a str,
    pub include_guidance: bool,
    pub suggestion_block: &'a dyn Fn(CiProvider, &CiIssue) -> Option<String>,
    pub guidance_block: &'a dyn Fn(&CiIssue) -> Option<String>,
}
Expand description

Inputs for rendering one inline review comment from a location group.

Fields§

§provider: CiProvider

CI provider whose comment shape to produce.

§group: &'a [&'group CiIssue]

Issues sharing the same (path, line); the first is the representative.

§gitlab_diff_refs: Option<&'a ReviewGitlabDiffRefs>

Required for GitLab positioned discussions; ignored for GitHub.

§diff_index: Option<&'a DiffIndex>

Diff index used to resolve renamed paths for GitLab positions.

§path_prefix: &'a str

Prepended to every emitted path after diff lookups have run.

§include_guidance: bool

Whether to append per-finding guidance blocks to the body.

§suggestion_block: &'a dyn Fn(CiProvider, &CiIssue) -> Option<String>

Produces a provider-specific suggestion block for a finding, when one applies.

§guidance_block: &'a dyn Fn(&CiIssue) -> Option<String>

Produces a guidance block for a finding, when one applies.

Auto Trait Implementations§

§

impl<'a, 'group> !RefUnwindSafe for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> !Send for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> !Sync for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> !UnwindSafe for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> Freeze for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> Unpin for ReviewCommentRenderInput<'a, 'group>

§

impl<'a, 'group> UnsafeUnpin for ReviewCommentRenderInput<'a, 'group>

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