vast4-rs 1.0.2

An implementation of VAST 4.2 FINAL.
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

/// Linear Ads are the video or audio formatted ads that play linearly within the streaming
/// content, meaning before the streaming content, during a break, or after the streaming
/// content.
///
/// ## Linear base type:
/// ```text
/// <xs:complexType name="Linear_Base_type">
///   <xs:attribute name="skipoffset" use="optional">
///   <xs:sequence>
///     <xs:element name="Icons" minOccurs="0" maxOccurs="1">
///     <xs:element name="TrackingEvents" minOccurs="0" maxOccurs="1" type="vast:TrackingEvents_type" />
///   </xs:sequence>
/// </xs:complexType>
/// ```
///
/// ## Linear in [`InLine`](crate::InLine):
/// ```text
/// <xs:complexType name="Linear">
///   <xs:complexContent>
///     <xs:extension base="vast:Linear_Base_type">
///       <xs:sequence>
///         <xs:element name="AdParameters" minOccurs="0" maxOccurs="1" type="vast:AdParameters_type">
///         <xs:element name="Duration" minOccurs="1" maxOccurs="1" type="xs:time">
///         <xs:element name="MediaFiles" minOccurs="1" maxOccurs="1">
///         <xs:element name="VideoClicks" minOccurs="0" maxOccurs="1" type="vast:VideoClicks_type" />
///       </xs:sequence>
///     </xs:extension>
///   </xs:complexContent>
/// </xs:complexType>
/// ```
///
/// ## Linear in [`Wrapper`](crate::Wrapper):
/// ```text
/// <xs:complexType name="Linear">
///   <xs:complexContent>
///     <xs:extension base="vast:Linear_Base_type">
///       <xs:sequence>
///         <xs:element name="VideoClicks" minOccurs="0" maxOccurs="1" type="vast:VideoClicks_type" />
///       </xs:sequence>
///     </xs:extension>
///   </xs:complexContent>
/// </xs:complexType>
/// ```
#[derive(hard_xml::XmlWrite, hard_xml::XmlRead, Default, PartialEq, Clone, Debug)]
#[xml(tag = "Linear")]
pub struct Linear<'a> {
    /// The time at which the ad becomes skippable, if absent, the ad is not skippable.
    #[xml(attr = "skipoffset", default)]
    pub skipoffset: Option<crate::Duration>,

    /// The container for zero or one [`<Icons>`](crate::Icons) element.
    #[xml(child = "Icons", default)]
    pub icons: Option<crate::Icons<'a>>,
    /// The container for zero or one [`<TrackingEvents>`](crate::TrackingEvents) element.
    #[xml(child = "TrackingEvents", default)]
    pub tracking_events: Option<crate::TrackingEvents<'a>>,

    /// InLine: The container for zero or one [`<AdParameters>`](AdParameters) element.
    /// Wrapper: No use this field.
    #[xml(child = "AdParameters", default)]
    pub ad_parameters: Option<AdParameters<'a>>,
    /// InLine: The ad server uses the [`<Duration>`](crate::Duration) element to denote the
    /// intended playback duration for the video or audio component of the ad. **Required this
    /// field inside [`InLine`](crate::InLine) element.**
    /// Wrapper: No use this field.
    #[xml(child = "Duration", default)]
    pub duration: Option<crate::Duration>,
    /// InLine: The container for zero or one [`<MediaFiles>`](crate::MediaFiles) element.
    /// **Required this field inside [`InLine`](crate::InLine) element.**
    /// Wrapper: No use this field.
    #[xml(child = "MediaFiles", default)]
    pub media_files: Option<crate::MediaFiles<'a>>,

    /// The container for zero or one [`<VideoClicks>`](crate::VideoClicks) element.
    #[xml(child = "VideoClicks", default)]
    pub video_clicks: Option<crate::VideoClicks<'a>>,
}

/// The `<AdParameters>` element is currently the only way to pass information from the
/// VAST response into the VPAID object.
///
/// ```text
/// <xs:complexType name="AdParameters">
///   <xs:simpleContent>
///     <xs:extension base="xs:string">
///       <xs:attribute name="xmlEncoded" type="xs:boolean" use="optional">
///     </xs:extension>
///   </xs:simpleContent>
/// </xs:complexType>
/// ```
#[derive(hard_xml::XmlWrite, hard_xml::XmlRead, Default, PartialEq, Clone, Debug)]
#[xml(tag = "AdParameters")]
pub struct AdParameters<'a> {
    /// Identifies whether the ad parameters are xml-encoded.
    #[xml(attr = "xmlEncoded", default)]
    pub xml_encoded: Option<bool>,

    /// Metadata for the ad.
    #[xml(text, default)]
    pub metadata: std::borrow::Cow<'a, str>,
}