Struct rosu_v2::model::comments::CommentBundle

pub struct CommentBundle {
    pub commentable_meta: Vec<CommentableMeta>,
    pub comments: Vec<Comment>,
    pub has_more_id: Option<u32>,
    pub included_comments: Vec<Comment>,
    pub pinned_comments: Option<Vec<Comment>>,
    pub sort: CommentSort,
    pub top_level_count: Option<u32>,
    pub total: Option<u32>,
    pub user_follow: bool,
    pub user_votes: Vec<u32>,
    pub users: Vec<UserCompact>,
    /* private fields */
}

Comments and related data.

Fields

commentable_meta: Vec<CommentableMeta>

ID of the object the comment is attached to

comments: Vec<Comment>

List of comments ordered according to sort

has_more_id: Option<u32>

included_comments: Vec<Comment>

Related comments; e.g. parent comments and nested replies

pinned_comments: Option<Vec<Comment>>

Pinned comments

sort: CommentSort

order of comments

top_level_count: Option<u32>

Number of comments at the top level. Not returned for replies.

total: Option<u32>

Total number of comments. Not retuned for replies.

user_follow: bool

is the current user watching the comment thread?

user_votes: Vec<u32>

IDs of the comments in the bundle the current user has upvoted

users: Vec<UserCompact>

List of users related to the comments

Implementations

impl CommentBundle

pub fn has_more(&self) -> bool

Returns whether there is a next page of comments, retrievable via get_next.

pub async fn get_next(&self, osu: &Osu) -> Option<OsuResult<CommentBundle>>

If has_more is true, the API can provide the next set of comments and this method will request them. Otherwise, this method returns None.

Trait Implementations

impl Clone for CommentBundle

fn clone(&self) -> CommentBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentBundle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommentBundle

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<CommentBundle> for CommentBundle

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CommentBundle