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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/* * This file is part of ActivityStreams Types. * * Copyright © 2018 Riley Trautman * * ActivityStreams Types is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * ActivityStreams Types is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with ActivityStreams Types. If not, see <http://www.gnu.org/licenses/>. */ //! Namespace for properties of standard Activity types //! //! To use these properties in your own types, you can flatten them into your struct with serde: //! //! ```rust //! extern crate activitystreams_traits; //! extern crate activitystreams_types; //! extern crate serde; //! #[macro_use] //! extern crate serde_derive; //! //! use activitystreams_traits::{Activity, Object}; //! use activitystreams_types::{ //! activity::properties::ActivityProperties, //! object::properties::ObjectProperties, //! }; //! //! #[derive(Clone, Debug, Serialize, Deserialize)] //! #[serde(rename_all = "camelCase")] //! pub struct MyActivity { //! #[serde(rename = "type")] //! pub kind: String, //! //! /// Define a require property for the MyActivity type //! pub my_property: String, //! //! #[serde(flatten)] //! pub object_properties: ObjectProperties, //! //! #[serde(flatten)] //! pub activity_properties: ActivityProperties, //! } //! //! impl Object for MyActivity {} //! impl Activity for MyActivity {} //! # //! # fn main() {} //! ``` use activitystreams_traits::{Link, Object}; use serde_json; /// Activity objects are specializations of the base Object type that provide information about /// actions that have either already occurred, are in the process of occurring, or may occur in the /// future. #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActivityProperties { /// Describes the result of the activity. /// /// For instance, if a particular action results in the creation of a new resource, the result /// property can be used to describe that new resource. /// /// - Range: `Object` | `Link` /// - Funcitonal: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub result: Option<serde_json::Value>, /// Identifies one or more objects used (or to be used) in the completion of an `Activity`. /// /// - Range: `Object` | `Link` /// - Funcitonal: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub instrument: Option<serde_json::Value>, } /// Struct with `actor` and optional `origin` and `target` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorOptOriginAndTarget { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// Describes an indirect object of the activity from which the activity is directed. /// /// The precise meaning of the origin is the object of the English preposition "from". For /// instance, in the activity "John moved an item to List B from List A", the origin of the /// activity is "List A". /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub origin: Option<serde_json::Value>, /// Describes the indirect object, or target, of the activity. /// /// The precise meaning of the target is largely dependent on the type of action being /// described but will often be the object of the English preposition "to". For instance, in /// the activity "John added a movie to his wishlist", the target of the activity is John's /// wishlist. An activity can have more than one target /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub target: Option<serde_json::Value>, } /// Struct with `actor` and `object` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorAndObject { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// When used within an Activity, describes the direct object of the activity. /// /// For instance, in the activity "John added a movie to his wishlist", the object of the /// activity is the movie added. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub object: serde_json::Value, } /// Struct with `actor`, `object`, and `target` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorObjectAndTarget { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// When used within an Activity, describes the direct object of the activity. /// /// For instance, in the activity "John added a movie to his wishlist", the object of the /// activity is the movie added. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub object: serde_json::Value, /// Describes the indirect object, or target, of the activity. /// /// The precise meaning of the target is largely dependent on the type of action being /// described but will often be the object of the English preposition "to". For instance, in /// the activity "John added a movie to his wishlist", the target of the activity is John's /// wishlist. An activity can have more than one target /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub target: serde_json::Value, } /// Struct with `actor`, `object`, and optional `target` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorAndObjectOptTarget { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// When used within an Activity, describes the direct object of the activity. /// /// For instance, in the activity "John added a movie to his wishlist", the object of the /// activity is the movie added. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub object: serde_json::Value, /// Describes the indirect object, or target, of the activity. /// /// The precise meaning of the target is largely dependent on the type of action being /// described but will often be the object of the English preposition "to". For instance, in /// the activity "John added a movie to his wishlist", the target of the activity is John's /// wishlist. An activity can have more than one target /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub target: Option<serde_json::Value>, } /// Struct with `actor`, `object`, and optional `origin` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorAndObjectOptOrigin { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// When used within an Activity, describes the direct object of the activity. /// /// For instance, in the activity "John added a movie to his wishlist", the object of the /// activity is the movie added. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub object: serde_json::Value, /// Describes an indirect object of the activity from which the activity is directed. /// /// The precise meaning of the origin is the object of the English preposition "from". For /// instance, in the activity "John moved an item to List B from List A", the origin of the /// activity is "List A". /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub origin: Option<serde_json::Value>, } /// Struct with `actor`, `object`, and optional `origin` and `target` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorAndObjectOptOthers { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// When used within an Activity, describes the direct object of the activity. /// /// For instance, in the activity "John added a movie to his wishlist", the object of the /// activity is the movie added. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub object: serde_json::Value, /// Describes an indirect object of the activity from which the activity is directed. /// /// The precise meaning of the origin is the object of the English preposition "from". For /// instance, in the activity "John moved an item to List B from List A", the origin of the /// activity is "List A". /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub origin: Option<serde_json::Value>, /// Describes the indirect object, or target, of the activity. /// /// The precise meaning of the target is largely dependent on the type of action being /// described but will often be the object of the English preposition "to". For instance, in /// the activity "John added a movie to his wishlist", the target of the activity is John's /// wishlist. An activity can have more than one target /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub target: Option<serde_json::Value>, } /// Struct with `actor` and `origin` properties #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct ActorAndOrigin { /// Describes one or more entities that either performed or are expected to perform the /// activity. /// /// Any single activity can have multiple actors. The actor MAY be specified using an indirect /// Link. /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub actor: serde_json::Value, /// Describes an indirect object of the activity from which the activity is directed. /// /// The precise meaning of the origin is the object of the English preposition "from". For /// instance, in the activity "John moved an item to List B from List A", the origin of the /// activity is "List A". /// /// - Range: `Object` | `Link` /// - Functional: false #[activitystreams(ab(Object, Link))] pub origin: serde_json::Value, } /// Properties for the Accept activity pub type AcceptProperties = ActorAndObject; /// Properties for the Add activity pub type AddProperties = ActorAndObject; /// Properties for the Move activity pub type MoveProperties = ActorAndObjectOptOthers; /// Properties for the Announce activity pub type AnnounceProperties = ActorAndObjectOptTarget; /// Properties for the Arrive activity pub type ArriveProperties = ActorAndOrigin; /// Properties for the Block activity pub type BlockProperties = ActorAndObject; /// Properties for the Create activity pub type CreateProperties = ActorAndObject; /// Properties for the Delete activity pub type DeleteProperties = ActorAndObjectOptOrigin; /// Properties for the Dislike activity pub type DislikeProperties = ActorAndObject; /// Properties for the Flag activity pub type FlagProperties = ActorAndObject; /// Properties for the Follow activity pub type FollowProperties = ActorAndObject; /// Properties for the Ignore activity pub type IgnoreProperties = ActorAndObject; /// Properties for the Invite activity pub type InviteProperties = ActorObjectAndTarget; /// Properties for the Join activity pub type JoinProperties = ActorAndObject; /// Properties for the Leave activity pub type LeaveProperties = ActorAndObject; /// Properties for the Like activity pub type LikeProperties = ActorAndObject; /// Properties for the Listen activity pub type ListenProperties = ActorAndObject; /// Properties for the Offer activity pub type OfferProperties = ActorAndObjectOptTarget; /// Properties for the Question activity #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)] #[serde(rename_all = "camelCase")] pub struct QuestionProperties { /// Identifies an exclusive option for a Question. /// /// Use of `one_of` implies that the Question can have only a single answer. To indicate that a /// `Question` can have multiple answers, use `any_of`. /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub one_of: Option<serde_json::Value>, /// Identifies an inclusive option for a Question. /// /// Use of `any_of` implies that the Question can have multiple answers. To indicate that a /// `Question` can have only one answer, use `one_of`. /// /// - Range: `Object` | `Link` /// - Functional: false #[serde(skip_serializing_if = "Option::is_none")] #[activitystreams(ab(Object, Link))] pub any_of: Option<serde_json::Value>, } /// Properties for the Read activity pub type ReadProperties = ActorAndObject; /// Properties for the Reject activity pub type RejectProperties = ActorAndObject; /// Properties for the Remove activity pub type RemoveProperties = ActorAndObjectOptOthers; /// Properties for the TentativeAccept activity pub type TentativeAcceptProperties = ActorAndObject; /// Properties for the TentativeReject activity pub type TentativeRejectProperties = ActorAndObject; /// Properties for the Travel activity pub type TravelProperties = ActorOptOriginAndTarget; /// Properties for the Undo activity pub type UndoProperties = ActorAndObject; /// Properties for the Update activity pub type UpdateProperties = ActorAndObject; /// Properties for the View activity pub type ViewProperties = ActorAndObject;