Struct html_tags::SourceOwned

pub struct SourceOwned {

    pub accesskey: Option<AttributeValueOwned>,
    pub autocapitalize: Option<AttributeValueOwned>,
    pub autofocus: Option<AttributeValueOwned>,
    pub class: Option<AttributeValueOwned>,
    pub contenteditable: Option<AttributeValueOwned>,
    pub contextmenu: Option<AttributeValueOwned>,
    pub data: BTreeMap<String, AttributeValueOwned>,
    pub dir: Option<AttributeValueOwned>,
    pub draggable: Option<AttributeValueOwned>,
    pub enterkeyhint: Option<AttributeValueOwned>,
    pub exportparts: Option<AttributeValueOwned>,
    pub extra: BTreeMap<String, AttributeValueOwned>,
    pub height: Option<AttributeValueOwned>,
    pub hidden: Option<AttributeValueOwned>,
    pub id: Option<AttributeValueOwned>,
    pub inert: Option<AttributeValueOwned>,
    pub inputmode: Option<AttributeValueOwned>,
    pub is: Option<AttributeValueOwned>,
    pub media: Option<AttributeValueOwned>,
    pub sizes: Option<AttributeValueOwned>,
    pub src: Option<AttributeValueOwned>,
    pub srcset: Option<AttributeValueOwned>,
    pub type_: Option<AttributeValueOwned>,
    pub width: Option<AttributeValueOwned>,
}

The <source> HTML element specifies multiple media resources for the <picture>, the <audio> element, or the <video> element. It is a void element, meaning that it has no content and does not have a closing tag. It is commonly used to offer the same media content in multiple file formats in order to provide compatibility with a broad range of browsers given their differing support for image file formats and media file formats.

More information: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/source

Fields

accesskey: Option<AttributeValueOwned>

Provides a hint for generating a keyboard shortcut for the current element. This attribute consists of a space-separated list of characters. The browser should use the first one that exists on the computer keyboard layout.

autocapitalize: Option<AttributeValueOwned>

Controls whether and how text input is automatically capitalized as it is entered/edited by the user. It can have the following values:

• off or none, no autocapitalization is applied (all letters default to lowercase)
• on or sentences, the first letter of each sentence defaults to a capital letter; all other letters default to lowercase
• words, the first letter of each word defaults to a capital letter; all other letters default to lowercase
• characters, all letters should default to uppercase

autofocus: Option<AttributeValueOwned>

Indicates that an element is to be focused on page load, or as soon as the <dialog> it is part of is displayed. This attribute is a boolean, initially false.

class: Option<AttributeValueOwned>

A space-separated list of the classes of the element. Classes allow CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().

contenteditable: Option<AttributeValueOwned>

An enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing. The attribute must take one of the following values:

• true or the empty string, which indicates that the element must be editable;
• false, which indicates that the element must not be editable.

contextmenu: Option<AttributeValueOwned>

The id of a <menu> to use as the contextual menu for this element.

data: BTreeMap<String, AttributeValueOwned>

Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts. All such custom data are available via the HTMLElement interface of the element the attribute is set on. The HTMLElement.dataset property gives access to them.

dir: Option<AttributeValueOwned>

An enumerated attribute indicating the directionality of the element's text. It can have the following values:

• ltr, which means left to right and is to be used for languages that are written from the left to the right (like English);
• rtl, which means right to left and is to be used for languages that are written from the right to the left (like Arabic);
• auto, which lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then it applies that directionality to the whole element.

draggable: Option<AttributeValueOwned>

An enumerated attribute indicating whether the element can be dragged, using the Drag and Drop API. It can have the following values:

• true, which indicates that the element may be dragged
• false, which indicates that the element may not be dragged.

enterkeyhint: Option<AttributeValueOwned>

Hints what action label (or icon) to present for the enter key on virtual keyboards.

exportparts: Option<AttributeValueOwned>

Used to transitively export shadow parts from a nested shadow tree into a containing light tree.

extra: BTreeMap<String, AttributeValueOwned>

/// Extra attributes of the element. This is a map of attribute names to their values, and the attribute names are in lowercase.

height: Option<AttributeValueOwned>

Allowed if the source element's parent is a <picture> element, but not allowed if the source element's parent is an <audio> or <video> element.

The intrinsic height of the image, in pixels. Must be an integer without a unit.

hidden: Option<AttributeValueOwned>

An enumerated attribute indicating that the element is not yet, or is no longer, relevant. For example, it can be used to hide elements of the page that can't be used until the login process has been completed. The browser won't render such elements. This attribute must not be used to hide content that could legitimately be shown.

id: Option<AttributeValueOwned>

Defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).

inert: Option<AttributeValueOwned>

A boolean value that makes the browser disregard user input events for the element. Useful when click events are present.

inputmode: Option<AttributeValueOwned>

Provides a hint to browsers about the type of virtual keyboard configuration to use when editing this element or its contents. Used primarily on <input> elements, but is usable on any element while in contenteditable mode.

is: Option<AttributeValueOwned>

Allows you to specify that a standard HTML element should behave like a registered custom built-in element (see Using custom elements for more details).

media: Option<AttributeValueOwned>

Allowed if the source element's parent is a <picture> element, but not allowed if the source element's parent is an <audio> or <video> element.

Media query of the resource's intended media.

sizes: Option<AttributeValueOwned>

Allowed if the source element's parent is a <picture> element, but not allowed if the source element's parent is an <audio> or <video> element.

A list of source sizes that describes the final rendered width of the image represented by the source. Each source size consists of a comma-separated list of media condition-length pairs. Before laying the page out, the browser uses this information to determine which image is defined in srcset to use. Please note that sizes will have its effect only if width dimension descriptors are provided with srcset instead of pixel ratio values (200w instead of 2x for example).

src: Option<AttributeValueOwned>

Required if the source element's parent is an <audio> and <video> element, but not allowed if the source element's parent is a <picture> element.

Address of the media resource.

srcset: Option<AttributeValueOwned>

Required if the source element's parent is a <picture> element, but not allowed if the source element's parent is an <audio> or <video> element.

A list of one or more strings, separated by commas, indicating a set of possible images represented by the source for the browser to use. Each string is composed of:

1. One URL specifying an image.
2. A width descriptor, which consists of a string containing a positive integer directly followed by "w", such as 300w. The default value, if missing, is the infinity.
3. A pixel density descriptor, that is a positive floating number directly followed by "x". The default value, if missing, is 1x.

Each string in the list must have at least a width descriptor or a pixel density descriptor to be valid. The two types of descriptors should not be mixed together and only one should be used consistently throughout the list. Among the list, the value of each descriptor must be unique. The browser chooses the most adequate image to display at a given point of time. If the sizes attribute is present, then a width descriptor must be specified for each string. If the browser does not support srcset, then src will be used for the default source.

type_: Option<AttributeValueOwned>

The MIME media type of the image or other media type, optionally with a codecs parameter.

width: Option<AttributeValueOwned>

Allowed if the source element's parent is a <picture> element, but not allowed if the source element's parent is an <audio> or <video> element.

The intrinsic width of the image in pixels. Must be an integer without a unit.

Implementations

impl SourceOwned

pub fn tag() -> &'static str

Get the tag name of the element. This is the same as the name of the struct, in kebab-case.

pub fn set_attr(&mut self, name: &str, value: impl Into<AttributeValueOwned>)

Sets an attribute of the element. This sets the attribute of the struct. If the attribute is not a known attribute, it is added to the extra map. If the alloc feature is disabled, this function will silently fail.

Note

This only works when the attribute is lowercase.

Trait Implementations

impl Clone for SourceOwned

fn clone(&self) -> SourceOwned

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceOwned

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SourceOwned

fn default() -> SourceOwned

Returns the “default value” for a type.

impl Ord for SourceOwned

fn cmp(&self, other: &SourceOwned) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SourceOwned> for SourceOwned

fn eq(&self, other: &SourceOwned) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<SourceOwned> for SourceOwned

fn partial_cmp(&self, other: &SourceOwned) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SourceOwned

impl StructuralEq for SourceOwned

impl StructuralPartialEq for SourceOwned