Struct gitlab::types::Note

pub struct Note {

    pub id: NoteId,
    pub note_type: Option<DiscussionNoteType>,
    pub body: String,
    pub attachment: Option<String>,
    pub author: UserBasic,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub resolvable: bool,
    pub resolved: Option<bool>,
    pub resolved_by: Option<UserBasic>,
    pub system: bool,
    pub noteable_type: NoteType,
    pub position: Option<NotePosition>,
    /* private fields */
}

A comment on an entity.

Fields

id: NoteId

The ID of the note.

note_type: Option<DiscussionNoteType>

The type of the note.

body: String

The content of the note.

attachment: Option<String>

The URL of an attachment to the note.

author: UserBasic

The author of the note.

created_at: DateTime<Utc>

When the note was created.

updated_at: DateTime<Utc>

When the note was last updated.

resolvable: bool

Whether the note can be resolved.

resolved: Option<bool>

Whether the note has been resolved.

resolved_by: Option<UserBasic>

The user that resolved the note.

system: bool

Whether the note was created by a user or in response to an external action.

System notes include indications that the commit, issue, etc. was referenced elsewhere, a milestone, assignee, or label change, status chages, and so on.

noteable_type: NoteType

The type of entity the note is attached to.

position: Option<NotePosition>

If applicable, the diff data to which the note is attached

Implementations

impl Note

pub fn noteable_id(&self) -> Option<NoteableId>

The ID of the entity the note is attached to.

pub fn noteable_iid(&self) -> Option<NoteableInternalId>

The internal ID of the entity the note is attached to (internal to a project). This is available only for notes attached to issues and merge requests.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Note

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Note

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

Serialize this value into the given Serde serializer.