Struct roctogen::models::PostPullsCreateReviewComment

pub struct PostPullsCreateReviewComment {
    pub body: Option<String>,
    pub commit_id: Option<String>,
    pub path: Option<String>,
    pub position: Option<i64>,
    pub side: Option<String>,
    pub line: Option<i64>,
    pub start_line: Option<i64>,
    pub start_side: Option<String>,
    pub in_reply_to: Option<i64>,
}

Fields

body: Option<String>

The text of the review comment.

commit_id: Option<String>

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

path: Option<String>

The relative path to the file that necessitates a comment.

position: Option<i64>

Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

side: Option<String>

Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request’s changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

line: Option<i64>

Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

start_line: Option<i64>

Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

start_side: Option<String>

Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

in_reply_to: Option<i64>

Trait Implementations

impl Clone for PostPullsCreateReviewComment

fn clone(&self) -> PostPullsCreateReviewComment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostPullsCreateReviewComment

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

Formats the value using the given formatter.

impl Default for PostPullsCreateReviewComment

fn default() -> PostPullsCreateReviewComment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PostPullsCreateReviewComment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<PostPullsCreateReviewComment> for PostPullsCreateReviewComment

fn eq(&self, other: &PostPullsCreateReviewComment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PostPullsCreateReviewComment) -> bool

This method tests for !=.

impl Serialize for PostPullsCreateReviewComment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PostPullsCreateReviewComment