Struct Iframe

pub struct Iframe<'life> {

    pub accesskey: Option<AttributeValue<'life>>,
    pub allow: Option<AttributeValue<'life>>,
    pub allowfullscreen: Option<AttributeValue<'life>>,
    pub allowpaymentrequest: Option<AttributeValue<'life>>,
    pub autocapitalize: Option<AttributeValue<'life>>,
    pub autofocus: Option<AttributeValue<'life>>,
    pub class: Option<AttributeValue<'life>>,
    pub contenteditable: Option<AttributeValue<'life>>,
    pub contextmenu: Option<AttributeValue<'life>>,
    pub credentialless: Option<AttributeValue<'life>>,
    pub csp: Option<AttributeValue<'life>>,
    pub data: BTreeMap<&'life str, AttributeValue<'life>>,
    pub dir: Option<AttributeValue<'life>>,
    pub draggable: Option<AttributeValue<'life>>,
    pub enterkeyhint: Option<AttributeValue<'life>>,
    pub exportparts: Option<AttributeValue<'life>>,
    pub extra: BTreeMap<&'life str, AttributeValue<'life>>,
    pub height: Option<AttributeValue<'life>>,
    pub hidden: Option<AttributeValue<'life>>,
    pub id: Option<AttributeValue<'life>>,
    pub inert: Option<AttributeValue<'life>>,
    pub inputmode: Option<AttributeValue<'life>>,
    pub is: Option<AttributeValue<'life>>,
    pub itemid: Option<AttributeValue<'life>>,
    pub itemprop: Option<AttributeValue<'life>>,
    pub itemref: Option<AttributeValue<'life>>,
    pub itemscope: Option<AttributeValue<'life>>,
    pub itemtype: Option<AttributeValue<'life>>,
    pub lang: Option<AttributeValue<'life>>,
    pub loading: Option<AttributeValue<'life>>,
    pub name: Option<AttributeValue<'life>>,
    pub nonce: Option<AttributeValue<'life>>,
    pub part: Option<AttributeValue<'life>>,
    pub popover: Option<AttributeValue<'life>>,
    pub referrerpolicy: Option<AttributeValue<'life>>,
    pub role: Option<AttributeValue<'life>>,
    pub sandbox: Option<AttributeValue<'life>>,
    pub slot: Option<AttributeValue<'life>>,
    pub spellcheck: Option<AttributeValue<'life>>,
    pub src: Option<AttributeValue<'life>>,
    pub srcdoc: Option<AttributeValue<'life>>,
    pub style: Option<AttributeValue<'life>>,
    pub tabindex: Option<AttributeValue<'life>>,
    pub title: Option<AttributeValue<'life>>,
    pub translate: Option<AttributeValue<'life>>,
    pub virtualkeyboardpolicy: Option<AttributeValue<'life>>,
    pub width: Option<AttributeValue<'life>>,
}

The <iframe> HTML element represents a nested browsing context, embedding another HTML page into the current one.

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

Fields

accesskey: Option<AttributeValue<'life>>

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.

allow: Option<AttributeValue<'life>>

Specifies a Permissions Policy for the <iframe>. The policy defines what features are available to the <iframe> (for example, access to the microphone, camera, battery, web-share, etc.) based on the origin of the request.

Note: A Permissions Policy specified by the allow attribute implements a further restriction on top of the policy specified in the Permissions-Policy header. It doesn't replace it.

allowfullscreen: Option<AttributeValue<'life>>

Set to true if the <iframe> can activate fullscreen mode by calling the requestFullscreen() method.

Note: This attribute is considered a legacy attribute and redefined as allow="fullscreen".

allowpaymentrequest: Option<AttributeValue<'life>>

Set to true if a cross-origin <iframe> should be allowed to invoke the Payment Request API.

Note: This attribute is considered a legacy attribute and redefined as allow="payment".

autocapitalize: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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

credentialless: Option<AttributeValue<'life>>

Set to true to make the <iframe> credentialless, meaning that its content will be loaded in a new, ephemeral context. It doesn't have access to the network, cookies, and storage data associated with its origin. It uses a new context local to the top-level document lifetime. In return, the Cross-Origin-Embedder-Policy (COEP) embedding rules can be lifted, so documents with COEP set can embed third-party documents that do not. See IFrame credentialless for more details.

csp: Option<AttributeValue<'life>>

A Content Security Policy enforced for the embedded resource. See HTMLIFrameElement.csp for details.

data: BTreeMap<&'life str, AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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

exportparts: Option<AttributeValue<'life>>

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

extra: BTreeMap<&'life str, AttributeValue<'life>>

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

height: Option<AttributeValue<'life>>

The height of the frame in CSS pixels. Default is 150.

hidden: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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<AttributeValue<'life>>

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

inputmode: Option<AttributeValue<'life>>

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<AttributeValue<'life>>

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).

itemid: Option<AttributeValue<'life>>

The unique, global identifier of an item.

itemprop: Option<AttributeValue<'life>>

Used to add properties to an item. Every HTML element may have an itemprop attribute specified, where an itemprop consists of a name and value pair.

itemref: Option<AttributeValue<'life>>

Properties that are not descendants of an element with the itemscope attribute can be associated with the item using an itemref. It provides a list of element ids (not itemids) with additional properties elsewhere in the document.

itemscope: Option<AttributeValue<'life>>

itemscope (usually) works along with itemtype to specify that the HTML contained in a block is about a particular item. itemscope creates the Item and defines the scope of the itemtype associated with it. itemtype is a valid URL of a vocabulary (such as schema.org) that describes the item and its properties context.

itemtype: Option<AttributeValue<'life>>

Specifies the URL of the vocabulary that will be used to define itemprops (item properties) in the data structure. itemscope is used to set the scope of where in the data structure the vocabulary set by itemtype will be active.

lang: Option<AttributeValue<'life>>

Helps define the language of an element: the language that non-editable elements are in, or the language that editable elements should be written in by the user. The attribute contains one "language tag" (made of hyphen-separated "language subtags") in the format defined in RFC 5646: Tags for Identifying Languages (also known as BCP 47). xml:lang has priority over it.

loading: Option<AttributeValue<'life>>

Indicates how the browser should load the iframe:

• eager: Load the iframe immediately, regardless if it is outside the visible viewport (this is the default value).
• lazy: Defer loading of the iframe until it reaches a calculated distance from the viewport, as defined by the browser.

name: Option<AttributeValue<'life>>

A targetable name for the embedded browsing context. This can be used in the target attribute of the <a>, <form>, or <base> elements; the formtarget attribute of the <input> or <button> elements; or the windowName parameter in the window.open() method.

nonce: Option<AttributeValue<'life>>

A cryptographic nonce ("number used once") which can be used by Content Security Policy to determine whether or not a given fetch will be allowed to proceed.

part: Option<AttributeValue<'life>>

A space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element.

popover: Option<AttributeValue<'life>>

Specifies that the element should be treated like a popover. An element with the popover attribute is hidden from the page unless it is opened by interacting with an invoking element that has popovertarget, or via showPopover().

referrerpolicy: Option<AttributeValue<'life>>

Indicates which referrer to send when fetching the frame's resource:

• no-referrer: The Referer header will not be sent.
• no-referrer-when-downgrade: The Referer header will not be sent to origins without TLS (HTTPS).
• origin: The sent referrer will be limited to the origin of the referring page: its scheme, host, and port.
• origin-when-cross-origin: The referrer sent to other origins will be limited to the scheme, the host, and the port. Navigations on the same origin will still include the path.
• same-origin: A referrer will be sent for same origin, but cross-origin requests will contain no referrer information.
• strict-origin: Only send the origin of the document as the referrer when the protocol security level stays the same (HTTPS→HTTPS), but don't send it to a less secure destination (HTTPS→HTTP).
• strict-origin-when-cross-origin (default): Send a full URL when performing a same-origin request, only send the origin when the protocol security level stays the same (HTTPS→HTTPS), and send no header to a less secure destination (HTTPS→HTTP).
• unsafe-url: The referrer will include the origin and the path (but not the fragment, password, or username). This value is unsafe, because it leaks origins and paths from TLS-protected resources to insecure origins.

role: Option<AttributeValue<'life>>

Roles define the semantic meaning of content, allowing screen readers and other tools to present and support interaction with an object in a way that is consistent with user expectations of that type of object. roles are added to HTML elements using role="role_type", where role_type is the name of a role in the ARIA specification.

sandbox: Option<AttributeValue<'life>>

<p>Applies extra restrictions to the content in the frame. The value of the attribute can either be empty to apply all restrictions, or space-separated tokens to lift particular restrictions:</p>
<ul>
  <li><code>allow-downloads</code>: Allows downloading files through an <a href="/en-US/docs/Web/HTML/Element/a"><code>&lt;a&gt;</code></a> or <a href="/en-US/docs/Web/HTML/Element/area"><code>&lt;area&gt;</code></a> element with the <a href="/en-US/docs/Web/HTML/Element/a#download">download</a> attribute, as well as through the navigation that leads to a download of a file. This works regardless of whether the user clicked on the link, or JS code initiated it without user interaction.</li>
  <li><code>allow-downloads-without-user-activation</code> <abbr title="Experimental. Expect behavior to change in the future." class="icon icon-experimental">
<span class="visually-hidden">Experimental</span>

: Allows for downloads to occur without a gesture from the user.

allow-forms: Allows the page to submit forms. If this keyword is not used, form will be displayed as normal, but submitting it will not trigger input validation, sending data to a web server or closing a dialog.

allow-modals: Allows the page to open modal windows by Window.alert(), Window.confirm(), Window.print() and Window.prompt(), while opening a <dialog> is allowed regardless of this keyword. It also allows the page to receive BeforeUnloadEvent event.

allow-orientation-lock: Lets the resource lock the screen orientation.

allow-pointer-lock: Allows the page to use the Pointer Lock API.

allow-popups: Allows popups (like from Window.open(), target=“_blank”, Window.showModalDialog()). If this keyword is not used, that functionality will silently fail.

allow-popups-to-escape-sandbox: Allows a sandboxed document to open new windows without forcing the sandboxing flags upon them. This will allow, for example, a third-party advertisement to be safely sandboxed without forcing the same restrictions upon the page the ad links to.

allow-presentation: Allows embedders to have control over whether an iframe can start a presentation session.

allow-same-origin: If this token is not used, the resource is treated as being from a special origin that always fails the same-origin policy (potentially preventing access to data storage/cookies and some JavaScript APIs).

allow-scripts: Allows the page to run scripts (but not create pop-up windows). If this keyword is not used, this operation is not allowed.

allow-storage-access-by-user-activation Experimental : Lets the resource request access to the parent’s storage capabilities with the Storage Access API.

allow-top-navigation: Lets the resource navigate the top-level browsing context (the one named _top).

allow-top-navigation-by-user-activation: Lets the resource navigate the top-level browsing context, but only if initiated by a user gesture.

allow-top-navigation-to-custom-protocols: Allows navigations to non-http protocols built into browser or registered by a website. This feature is also activated by allow-popups or allow-top-navigation keyword.

Note:

• When the embedded document has the same origin as the embedding page, it is strongly discouraged to use both allow-scripts and allow-same-origin, as that lets the embedded document remove the sandbox attribute — making it no more secure than not using the sandbox attribute at all.
• Sandboxing is useless if the attacker can display content outside a sandboxed iframe — such as if the viewer opens the frame in a new tab. Such content should be also served from a separate origin to limit potential damage.

slot: Option<AttributeValue<'life>>

Assigns a slot in a shadow DOM shadow tree to an element: An element with a slot attribute is assigned to the slot created by the <slot> element whose name attribute's value matches that slot attribute's value.

spellcheck: Option<AttributeValue<'life>>

An enumerated attribute defines whether the element may be checked for spelling errors. It may have the following values:

• empty string or true, which indicates that the element should be, if possible, checked for spelling errors;
• false, which indicates that the element should not be checked for spelling errors.

src: Option<AttributeValue<'life>>

The URL of the page to embed. Use a value of about:blank to embed an empty page that conforms to the same-origin policy. Also note that programmatically removing an <iframe>'s src attribute (e.g. via Element.removeAttribute()) causes about:blank to be loaded in the frame in Firefox (from version 65), Chromium-based browsers, and Safari/iOS.

srcdoc: Option<AttributeValue<'life>>

Inline HTML to embed, overriding the src attribute. If a browser does not support the srcdoc attribute, it will fall back to the URL in the src attribute.

style: Option<AttributeValue<'life>>

Contains CSS styling declarations to be applied to the element. Note that it is recommended for styles to be defined in a separate file or files. This attribute and the <style> element have mainly the purpose of allowing for quick styling, for example for testing purposes.

tabindex: Option<AttributeValue<'life>>

An integer attribute indicating if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position. It can take several values:

• a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
• 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
• a positive value means that the element should be focusable and reachable via sequential keyboard navigation; the order in which the elements are focused is the increasing value of the tabindex. If several elements share the same tabindex, their relative order follows their relative positions in the document.

title: Option<AttributeValue<'life>>

Contains a text representing advisory information related to the element it belongs to. Such information can typically, but not necessarily, be presented to the user as a tooltip.

translate: Option<AttributeValue<'life>>

An enumerated attribute that is used to specify whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged. It can have the following values:

• empty string or yes, which indicates that the element will be translated.
• no, which indicates that the element will not be translated.

virtualkeyboardpolicy: Option<AttributeValue<'life>>

An enumerated attribute used to control the on-screen virtual keyboard behavior on devices such as tablets, mobile phones, or other devices where a hardware keyboard may not be available for elements that also uses the contenteditable attribute.

• auto or an empty string, which automatically shows the virtual keyboard when the element is focused or tapped.
• manual, which decouples focus and tap on the element from the virtual keyboard's state.

width: Option<AttributeValue<'life>>

The width of the frame in CSS pixels. Default is 300.

Implementations

impl<'life> Iframe<'life>

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: &'life str, value: impl Into<AttributeValue<'life>>, )

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<'life> Clone for Iframe<'life>

fn clone(&self) -> Iframe<'life>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for Iframe<'life>

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

Formats the value using the given formatter.

impl<'life> Default for Iframe<'life>

fn default() -> Iframe<'life>

Returns the “default value” for a type.

impl<'life> Ord for Iframe<'life>

fn cmp(&self, other: &Iframe<'life>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'life> PartialEq for Iframe<'life>

fn eq(&self, other: &Iframe<'life>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'life> PartialOrd for Iframe<'life>

fn partial_cmp(&self, other: &Iframe<'life>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'life> Eq for Iframe<'life>

impl<'life> StructuralPartialEq for Iframe<'life>