Struct octorust::types::PullsCreateReviewCommentRequest

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

Fields

body: String

The text of the review comment.

commit_id: 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.

in_reply_to: i64

line: 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.

path: String

The relative path to the file that necessitates a comment.

position: 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<PullsCreateReviewCommentRequestSide>

**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.

start_line: 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<PullsCreateReviewCommentRequestStartSide>

**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.

Trait Implementations

impl Clone for PullsCreateReviewCommentRequest

fn clone(&self) -> PullsCreateReviewCommentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PullsCreateReviewCommentRequest

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

Formats the value using the given formatter.

impl Default for PullsCreateReviewCommentRequest

fn default() -> PullsCreateReviewCommentRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PullsCreateReviewCommentRequest

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PullsCreateReviewCommentRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for PullsCreateReviewCommentRequest

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

Serialize this value into the given Serde serializer.