docs(all): Added documentation to missing parts

This commit is contained in:
Aaron Power
2017-11-11 11:50:09 +00:00
parent 87bcc139bb
commit b445197381
15 changed files with 203 additions and 13 deletions
+13
View File
@@ -1,25 +1,38 @@
//! Module containing all info about notifications.
use chrono::prelude::*;
use super::account::Account;
use super::status::Status;
/// A struct containing info about a notification.
#[derive(Debug, Clone, Deserialize)]
pub struct Notification {
/// The notification ID.
pub id: u64,
/// The type of notification.
#[serde(rename = "type")]
pub notification_type: NotificationType,
/// The time the notification was created.
pub created_at: DateTime<Utc>,
/// The Account sending the notification to the user.
pub account: Account,
/// The Status associated with the notification, if applicable.
pub status: Option<Status>,
}
/// The type of notification.
#[derive(Debug, Clone, Deserialize)]
pub enum NotificationType {
/// Someone mentioned the application client in another status.
#[serde(rename = "mention")]
Mention,
/// Someone reblogged one of the application client's statuses.
#[serde(rename = "reblog")]
Reblog,
/// Someone favourited one of the application client's statuses.
#[serde(rename = "favourite")]
Favourite,
/// Someone followed the application client.
#[serde(rename = "follow")]
Follow,
}