html_sys/embedded/
video.rs

1/// The HTML `<video>` element
2///
3/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video)
4#[doc(alias = "video")]
5#[non_exhaustive]
6#[derive(Debug, Clone, PartialEq, Default)]
7pub struct Video {
8    pub data_map: crate::DataMap,
9    global_attrs: crate::GlobalAttributes,
10    /// Address of the resource
11    pub src: std::option::Option<std::borrow::Cow<'static, str>>,
12    /// How the element handles crossorigin requests
13    pub crossorigin: std::option::Option<std::borrow::Cow<'static, str>>,
14    /// Poster frame to show prior to video playback
15    pub poster: std::option::Option<std::borrow::Cow<'static, str>>,
16    /// Hints how much buffering the media resource will likely need
17    pub preload: std::option::Option<std::borrow::Cow<'static, str>>,
18    /// Hint that the media resource can be started automatically when the page is loaded
19    pub autoplay: std::option::Option<std::borrow::Cow<'static, str>>,
20    /// Encourage the user agent to display video content within the element's playback area
21    pub plays_inline: bool,
22    /// Whether to loop the media resource
23    pub loop_: std::option::Option<std::borrow::Cow<'static, str>>,
24    /// Whether to mute the media resource by default
25    pub muted: std::option::Option<std::borrow::Cow<'static, str>>,
26    /// Show user agent controls
27    pub controls: std::option::Option<std::borrow::Cow<'static, str>>,
28    /// Horizontal dimension
29    pub width: std::option::Option<i64>,
30    /// Vertical dimension
31    pub height: std::option::Option<i64>,
32    /// Describes the role(s) the current element plays in the context of the document.
33    pub role: std::option::Option<std::borrow::Cow<'static, str>>,
34    /// Identifies the currently active element when DOM focus is on a composite widget, combobox, textbox, group, or application.
35    pub aria_active_descendant_element: std::option::Option<
36        std::borrow::Cow<'static, str>,
37    >,
38    /// Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
39    pub aria_atomic: bool,
40    /// Defines a string value that labels the current element, which is intended to be converted into Braille. See related aria-label.
41    pub aria_braille_label: std::option::Option<std::borrow::Cow<'static, str>>,
42    /// Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. See related aria-roledescription.
43    pub aria_braille_role_description: std::option::Option<
44        std::borrow::Cow<'static, str>,
45    >,
46    /// Indicates an element is being modified and that assistive technologies could wait until the modifications are complete before exposing them to the user.
47    pub aria_busy: bool,
48    /// Identifies the element (or elements) whose contents or presence are controlled by the current element. See related aria-owns.
49    pub aria_controls_elements: std::option::Option<std::borrow::Cow<'static, str>>,
50    /// Indicates the element that represents the current item within a container or set of related elements.
51    pub aria_current: std::option::Option<std::borrow::Cow<'static, str>>,
52    /// Identifies the element (or elements) that describes the object. See related aria-labelledby and aria-description.
53    pub aria_described_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
54    /// Defines a string value that describes or annotates the current element. See related aria-describedby.
55    pub aria_description: std::option::Option<std::borrow::Cow<'static, str>>,
56    /// Identifies the element (or elements) that provide additional information related to the object. See related aria-describedby.
57    pub aria_details_elements: std::option::Option<std::borrow::Cow<'static, str>>,
58    /// Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related aria-hidden and aria-readonly.
59    pub aria_disabled: bool,
60    /// [Deprecated in ARIA 1.1] Indicates what functions can be performed when a dragged object is released on the drop target.
61    pub aria_drop_effect: std::option::Option<std::borrow::Cow<'static, str>>,
62    /// Identifies the element (or elements) that provides an error message for an object. See related aria-invalid and aria-describedby.
63    pub aria_error_message_elements: std::option::Option<std::borrow::Cow<'static, str>>,
64    /// Indicates whether a grouping element owned or controlled by this element is expanded or collapsed.
65    pub aria_expanded: bool,
66    /// Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
67    pub aria_flow_to_elements: std::option::Option<std::borrow::Cow<'static, str>>,
68    /// [Deprecated in ARIA 1.1] Indicates an element's "grabbed" state in a drag-and-drop operation.
69    pub aria_grabbed: bool,
70    /// Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
71    pub aria_has_popup: std::option::Option<std::borrow::Cow<'static, str>>,
72    /// Indicates whether the element is exposed to an accessibility API. See related aria-disabled.
73    pub aria_hidden: bool,
74    /// Indicates the entered value does not conform to the format expected by the application. See related aria-errormessage.
75    pub aria_invalid: std::option::Option<std::borrow::Cow<'static, str>>,
76    /// Defines keyboard shortcuts that an author has implemented to activate or give focus to an element.
77    pub aria_key_shortcuts: std::option::Option<std::borrow::Cow<'static, str>>,
78    /// Defines a string value that labels the current element. See related aria-labelledby.
79    pub aria_label: std::option::Option<std::borrow::Cow<'static, str>>,
80    /// Identifies the element (or elements) that labels the current element. See related aria-label and aria-describedby.
81    pub aria_labelled_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
82    /// Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
83    pub aria_live: std::option::Option<std::borrow::Cow<'static, str>>,
84    /// Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See related aria-controls.
85    pub aria_owns_elements: std::option::Option<std::borrow::Cow<'static, str>>,
86    /// Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See related aria-atomic.
87    pub aria_relevant: std::option::Option<std::borrow::Cow<'static, str>>,
88    /// Defines a human-readable, author-localized description for the role of an element.
89    pub aria_role_description: std::option::Option<std::borrow::Cow<'static, str>>,
90}
91impl crate::RenderElement for Video {
92    fn write_opening_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
93        write!(writer, "<video")?;
94        if let Some(field) = self.src.as_ref() {
95            write!(writer, r#" src="{field}""#)?;
96        }
97        if let Some(field) = self.crossorigin.as_ref() {
98            write!(writer, r#" crossorigin="{field}""#)?;
99        }
100        if let Some(field) = self.poster.as_ref() {
101            write!(writer, r#" poster="{field}""#)?;
102        }
103        if let Some(field) = self.preload.as_ref() {
104            write!(writer, r#" preload="{field}""#)?;
105        }
106        if let Some(field) = self.autoplay.as_ref() {
107            write!(writer, r#" autoplay="{field}""#)?;
108        }
109        if self.plays_inline {
110            write!(writer, r#" playsinline"#)?;
111        }
112        if let Some(field) = self.loop_.as_ref() {
113            write!(writer, r#" loop="{field}""#)?;
114        }
115        if let Some(field) = self.muted.as_ref() {
116            write!(writer, r#" muted="{field}""#)?;
117        }
118        if let Some(field) = self.controls.as_ref() {
119            write!(writer, r#" controls="{field}""#)?;
120        }
121        if let Some(field) = self.width.as_ref() {
122            write!(writer, r#" width="{field}""#)?;
123        }
124        if let Some(field) = self.height.as_ref() {
125            write!(writer, r#" height="{field}""#)?;
126        }
127        if let Some(field) = self.role.as_ref() {
128            write!(writer, r#" role="{field}""#)?;
129        }
130        if let Some(field) = self.aria_active_descendant_element.as_ref() {
131            write!(writer, r#" aria-activedescendant="{field}""#)?;
132        }
133        if self.aria_atomic {
134            write!(writer, r#" aria-atomic"#)?;
135        }
136        if let Some(field) = self.aria_braille_label.as_ref() {
137            write!(writer, r#" aria-braillelabel="{field}""#)?;
138        }
139        if let Some(field) = self.aria_braille_role_description.as_ref() {
140            write!(writer, r#" aria-brailleroledescription="{field}""#)?;
141        }
142        if self.aria_busy {
143            write!(writer, r#" aria-busy"#)?;
144        }
145        if let Some(field) = self.aria_controls_elements.as_ref() {
146            write!(writer, r#" aria-controls="{field}""#)?;
147        }
148        if let Some(field) = self.aria_current.as_ref() {
149            write!(writer, r#" aria-current="{field}""#)?;
150        }
151        if let Some(field) = self.aria_described_by_elements.as_ref() {
152            write!(writer, r#" aria-describedby="{field}""#)?;
153        }
154        if let Some(field) = self.aria_description.as_ref() {
155            write!(writer, r#" aria-description="{field}""#)?;
156        }
157        if let Some(field) = self.aria_details_elements.as_ref() {
158            write!(writer, r#" aria-details="{field}""#)?;
159        }
160        if self.aria_disabled {
161            write!(writer, r#" aria-disabled"#)?;
162        }
163        if let Some(field) = self.aria_drop_effect.as_ref() {
164            write!(writer, r#" aria-dropeffect="{field}""#)?;
165        }
166        if let Some(field) = self.aria_error_message_elements.as_ref() {
167            write!(writer, r#" aria-errormessage="{field}""#)?;
168        }
169        if self.aria_expanded {
170            write!(writer, r#" aria-expanded"#)?;
171        }
172        if let Some(field) = self.aria_flow_to_elements.as_ref() {
173            write!(writer, r#" aria-flowto="{field}""#)?;
174        }
175        if self.aria_grabbed {
176            write!(writer, r#" aria-grabbed"#)?;
177        }
178        if let Some(field) = self.aria_has_popup.as_ref() {
179            write!(writer, r#" aria-haspopup="{field}""#)?;
180        }
181        if self.aria_hidden {
182            write!(writer, r#" aria-hidden"#)?;
183        }
184        if let Some(field) = self.aria_invalid.as_ref() {
185            write!(writer, r#" aria-invalid="{field}""#)?;
186        }
187        if let Some(field) = self.aria_key_shortcuts.as_ref() {
188            write!(writer, r#" aria-keyshortcuts="{field}""#)?;
189        }
190        if let Some(field) = self.aria_label.as_ref() {
191            write!(writer, r#" aria-label="{field}""#)?;
192        }
193        if let Some(field) = self.aria_labelled_by_elements.as_ref() {
194            write!(writer, r#" aria-labelledby="{field}""#)?;
195        }
196        if let Some(field) = self.aria_live.as_ref() {
197            write!(writer, r#" aria-live="{field}""#)?;
198        }
199        if let Some(field) = self.aria_owns_elements.as_ref() {
200            write!(writer, r#" aria-owns="{field}""#)?;
201        }
202        if let Some(field) = self.aria_relevant.as_ref() {
203            write!(writer, r#" aria-relevant="{field}""#)?;
204        }
205        if let Some(field) = self.aria_role_description.as_ref() {
206            write!(writer, r#" aria-roledescription="{field}""#)?;
207        }
208        write!(writer, "{}", self.global_attrs)?;
209        write!(writer, "{}", self.data_map)?;
210        write!(writer, ">")?;
211        Ok(())
212    }
213    #[allow(unused_variables)]
214    fn write_closing_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
215        write!(writer, "</video>")?;
216        Ok(())
217    }
218}
219impl std::fmt::Display for Video {
220    fn fmt(&self, writer: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
221        use crate::RenderElement;
222        self.write_opening_tag(writer)?;
223        self.write_closing_tag(writer)?;
224        Ok(())
225    }
226}
227impl std::ops::Deref for Video {
228    type Target = crate::GlobalAttributes;
229    fn deref(&self) -> &Self::Target {
230        &self.global_attrs
231    }
232}
233impl std::ops::DerefMut for Video {
234    fn deref_mut(&mut self) -> &mut Self::Target {
235        &mut self.global_attrs
236    }
237}
html_sys/embedded/video.rs

html_sys/embedded/
video.rs
