activitystreams 0.6.2

Activity Streams 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

/*
 * This file is part of ActivityStreams.
 *
 * Copyright © 2020 Riley Trautman
 *
 * ActivityStreams 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 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.  If not, see <http://www.gnu.org/licenses/>.
 */

//! Types defined as 'primitives' are used as building-blocks for ActivityStreams objects.
//!
//! For example, an `Object` may have a `summary` field, which is defined as a range of
//! `xsd:string` and `rdf:langString`. As code, this is represented as an enum that either
//! contains an `XsdString` or an `RdfLangString`.
//!
//! ```rust
//! use activitystreams::primitives::{RdfLangString, XsdString};
//!
//! /// Define a terminating enum for the Summary field in Object Properties
//! ///
//! /// In this case, terminating means it does not contain child elements.
//! pub enum ObjectPropertiesSummaryTermEnum {
//!     XsdString(XsdString),
//!     RdfLangString(RdfLangString),
//! }
//!
//! /// Since summary isn't functional, we can either have a single string, or multiple strings.
//! pub enum ObjectPropertiesSummaryEnum {
//!     Term(ObjectPropertiesSummaryTermEnum),
//!     Array(Vec<ObjectPropertiesSummaryTermEnum>),
//! }
//!
//! /// Define an excerpt from the ObjectProperties struct
//! pub struct ObjectProperties {
//!     // ...
//!
//!     /// Since summary isn't a required field, it's stored as an option
//!     summary: Option<ObjectPropertiesSummaryEnum>,
//!
//!     // ...
//! }
//! #
//! # fn main() {}
//! ```

mod length;
mod mime_media_type;
mod rdf_lang_string;
mod xsd_any_uri;
mod xsd_datetime;
mod xsd_duration;
mod xsd_float;
mod xsd_non_negative_float;
mod xsd_non_negative_integer;
mod xsd_string;

pub use self::{
    length::Length,
    mime_media_type::{MimeMediaType, MimeMediaTypeError},
    rdf_lang_string::RdfLangString,
    xsd_any_uri::{XsdAnyUri, XsdAnyUriError},
    xsd_datetime::{XsdDateTime, XsdDateTimeError},
    xsd_duration::{XsdDuration, XsdDurationError},
    xsd_float::{XsdFloat, XsdFloatError},
    xsd_non_negative_float::{XsdNonNegativeFloat, XsdNonNegativeFloatError},
    xsd_non_negative_integer::{XsdNonNegativeInteger, XsdNonNegativeIntegerError},
    xsd_string::XsdString,
};