dialtone_common 0.1.0

Dialtone Common Code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use crate::ap::image_attr::ImageAttributes;
use crate::ap::Actor;
use crate::webfinger::Jrd;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

/// This struct consists of the "public" information about
/// an actor, which is the Activity Pub Actor data and
/// the JRD data.
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct PublicActor {
    pub ap: Actor,
    pub jrd: Option<Jrd>,
}

/// An owned actors is one typically owned by a users
/// or many users. These actors have other non-activity-pub
/// data associated with them, primarily web-finger JRD data.
/// However, some actors are seen by the system through activity pub
/// or webfinger and therefore are orphaned actors.
/// For this system, the "owned" aspect means the owner gets
/// to make changes to the actors data, whether it is public data
/// or non-public data (i.e. owner_data). For orphaned actors only
/// the system gets to make those changes.
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct OwnedActor {
    pub ap: Actor,
    pub jrd: Option<Jrd>,
    pub owner_data: Option<OwnerActorData>,
    pub created_at: DateTime<Utc>,
    pub modified_at: DateTime<Utc>,
}

#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct OwnerActorData {}

/// For updating actors activity pub data.
/// This includes only the parts of AP data that may
/// be updated, such as 'names' and 'summary'. Some parts
/// of an AP actors are immutable (or server controlled)
/// and therefore cannot be updated.
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct UpdateOwnerActorAp {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub icon: Option<ImageAttributes>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub image: Option<ImageAttributes>,
}

/// This structure contains information that is more
/// of the "administrative" type about an Actor and only
/// intended to be modified by system operators or
/// moderators.
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct ActorSystemInfo {
    pub actor_id: String,
    pub visibility: ActorVisibility,
    pub system_data: Option<SystemActorData>,
}

#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct SystemActorData {}

#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub enum ActorVisibility {
    Visible,
    Invisible,
    Banned,
}

#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub struct ActorPage {
    pub min_modified_at: DateTime<Utc>,
    pub max_modified_at: DateTime<Utc>,
    pub page_values: Vec<Actor>,
}