Struct ThreadCommentOptions 

pub struct ThreadCommentOptions {
    pub policy: CommentPolicy,
    pub comment: String,
    pub kind: CommentKind,
    pub marker: String,
    pub no_lgtm: bool,
}

Options that control posting comments on a thread.

Used as a parameter value to RestApiClient::post_thread_comment().

Fields

policy: CommentPolicy

Controls posting comments on a thread that concerns a Pull Request or Push event.

Typically, this is only desirable for Pull Requests.

comment: String

The comment to post.

This can be a blank string if Self::no_lgtm is true and the Self::kind is CommentKind::Lgtm.

kind: CommentKind

The CommentKind that describes the comment’s purpose.

marker: String

A string used to mark/identify the thread’s comment 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 a 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 -->

no_lgtm: bool

Disallow posting “Looks Good To Me” comments.

Setting this option to true may instigate the deletion of old bot comment(s), if any exist.

Implementations

impl ThreadCommentOptions

pub fn mark_comment(&self) -> String

Ensure that the ThreadCommentOptions::comment is marked with the ThreadCommentOptions::marker.

Typically only used by implementations of RestApiClient::post_thread_comment and RestApiClient::append_step_summary.

Trait Implementations

impl Debug for ThreadCommentOptions

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

Formats the value using the given formatter.

impl Default for ThreadCommentOptions

fn default() -> Self

Returns the “default value” for a type.