resonite 0.4.0

Resonite's API in rust
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use std::collections::HashSet;

use serde::{Deserialize, Serialize};
use time::{OffsetDateTime, serde::rfc3339};

#[cfg_attr(
	feature = "borsh",
	derive(borsh::BorshSerialize, borsh::BorshDeserialize)
)]
#[serde_with::serde_as]
#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// A Resonite record, used for all kinds of storage objects
pub struct Record {
	#[serde(default)]
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	#[serde(alias = "neosDBmanifest")]
	/// Details about the asset
	pub asset_manifest: Vec<crate::model::DBAsset>,
	/// The URI that this record points to
	pub asset_uri: crate::AssetUrl,
	#[cfg_attr(
		feature = "borsh",
		borsh(
			serialize_with = "crate::util::borsh::time::optional_ser",
			deserialize_with = "crate::util::borsh::time::optional_de"
		)
	)]
	#[serde(default)]
	#[serde(with = "crate::util::opt_rfc3339")]
	#[serde(skip_serializing_if = "Option::is_none")]
	/// When the record was created at
	pub creation_time: Option<OffsetDateTime>,
	#[serde(default)]
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	/// The user readable description of the record
	///
	/// Defaults to an empty string if null/none in the API.
	pub description: String,
	#[cfg_attr(
		feature = "borsh",
		borsh(
			serialize_with = "crate::util::borsh::time::optional_ser",
			deserialize_with = "crate::util::borsh::time::optional_de"
		)
	)]
	#[serde(default)]
	#[serde(with = "crate::util::opt_rfc3339")]
	#[serde(skip_serializing_if = "Option::is_none")]
	/// When the record was first published at
	pub first_publish_time: Option<OffsetDateTime>,
	/// The id of the record
	pub id: crate::id::Record,
	/// If the record has been deleted or not
	pub is_deleted: bool,
	/// If the record is intended for patrons
	pub is_for_patrons: bool,
	/// If the record should be publicly findable
	pub is_listed: bool,
	/// If the record is public or not
	pub is_public: bool,
	#[cfg_attr(
		feature = "borsh",
		borsh(
			serialize_with = "crate::util::borsh::time::ser",
			deserialize_with = "crate::util::borsh::time::de"
		)
	)]
	#[serde(with = "rfc3339")]
	/// When the record was last modified at
	pub last_modification_time: OffsetDateTime,
	/// The user readable name of the record
	pub name: String,
	/// The owner of the record
	pub owner_id: crate::id::Owner,
	#[serde(default)]
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	/// The user readable name of the owner
	///
	/// Defaults to an empty string if null/none in the API.
	pub owner_name: String,
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	#[serde(default)]
	/// The path to this record
	///
	/// Defaulted to empty string if it doesn't exist.
	pub path: String,
	/// Number for random ordering
	pub random_order: u32,
	/// The rating of the record
	pub rating: f32,
	// TODO: Determine if common cases -> enumify
	/// The type of the record
	pub record_type: String,
	#[serde(default)]
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	/// The record's submissions to groups
	pub submissions: Vec<crate::model::Submission>,
	#[serde(default)]
	#[serde_as(deserialize_as = "serde_with::DefaultOnError")]
	/// The tags of the record
	pub tags: HashSet<String>,
	#[serde_as(deserialize_as = "serde_with::DefaultOnNull")]
	#[serde(skip_serializing_if = "Option::is_none")]
	#[serde(default)]
	/// The URI that this record's thumbnail is at
	pub thumbnail_uri: Option<crate::AssetUrl>,
	// TODO: Support legacy fields
	/// The version of the  record
	pub version: RecordVersion,
	/// If the record should be publicly findable
	pub visits: u32,
}

#[cfg_attr(
	feature = "borsh",
	derive(borsh::BorshSerialize, borsh::BorshDeserialize)
)]
#[derive(Debug, PartialEq, Eq, Hash, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// Versioning for a record
pub struct RecordVersion {
	/// The version of the asset, in the global scope
	pub global_version: u32,
	/// The machine ID of whoever last modified the record.
	///
	/// Might not always start with `M-` though.
	pub last_modifying_machine_id: String,
	/// Who last modified the record
	pub last_modifying_user_id: crate::id::User,
	/// The version of the asset, in the local scope
	pub local_version: u32,
}