Struct ReviewOptions 

pub struct ReviewOptions {
    pub action: ReviewAction,
    pub summary: String,
    pub comments: Vec<ReviewComment>,
    pub marker: String,
    pub allow_draft: bool,
    pub allow_closed: bool,
    pub delete_review_comments: bool,
}

A struct to describe a Pull Request review.

Each review is considered to be about the PR event’s changes. There is no support for posting reviews on older/outdated PR events.

Fields

action: ReviewAction

The course of action that the PR review suggests.

summary: String

A summary of the PR review.

This is an overview of the review’s comments.

comments: Vec<ReviewComment>

A list of comments for changes to the PR.

marker: String

A string used to mark/identify each comment (and Self::summary) as a comment submitted by this software.

User comments may be indistinguishable from bot/generated comments if this value is not unique enough.

If the git server employs Markdown syntax for comments, then it is recommended to set this to an HTML comment that is unique to your CI application:

<!-- my-cool-CI-app-name -->

The default value for this is an HTML comment generated from this crate’s name and version along with the compile-tome’s datetime. For example:

<!-- git-bot-feedback/0.1.0/Jul-14-2025_17-00 -->

allow_draft: bool

Allow posting reviews on draft Pull Requests?

allow_closed: bool

Allow posting reviews on closed Pull Requests?

delete_review_comments: bool

Permanently delete PR review outdated comments instead of hiding them.

Here be dragons! Use with extreme caution when asserting this flag. Setting this flag as true will permanently delete PR review comments that may be pivotal to a thread of discussion.

Note, this does not apply to PR review summary comments nor threads of discussion within a review.

Trait Implementations

impl Clone for ReviewOptions

fn clone(&self) -> ReviewOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReviewOptions

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

Formats the value using the given formatter.

impl Default for ReviewOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ReviewOptions

fn eq(&self, other: &ReviewOptions) -> 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 Eq for ReviewOptions

impl StructuralPartialEq for ReviewOptions