Struct html_tags::Script

pub struct Script<'life> {

    pub accesskey: Option<&'life str>,
    pub async_: Option<&'life str>,
    pub autocapitalize: Option<&'life str>,
    pub autofocus: Option<bool>,
    pub blocking: Option<&'life str>,
    pub class: Option<&'life str>,
    pub contenteditable: Option<&'life str>,
    pub contextmenu: Option<&'life str>,
    pub crossorigin: Option<&'life str>,
    pub data: Option<BTreeMap<&'life str, &'life str>>,
    pub defer: Option<&'life str>,
    pub dir: Option<&'life str>,
    pub draggable: Option<&'life str>,
    pub enterkeyhint: Option<&'life str>,
    pub exportparts: Option<&'life str>,
    pub fetchpriority: Option<&'life str>,
    pub hidden: Option<bool>,
    pub id: Option<&'life str>,
    pub inert: Option<&'life str>,
    pub inputmode: Option<&'life str>,
    pub integrity: Option<&'life str>,
    pub is: Option<&'life str>,
    pub nomodule: Option<&'life str>,
    pub nonce: Option<&'life str>,
    pub referrerpolicy: Option<&'life str>,
    pub src: Option<&'life str>,
    pub type_: Option<&'life str>,
}

The <script> HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code. The <script> element can also be used with other languages, such as WebGL’s GLSL shader programming language and JSON.

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

Fields

accesskey: Option<&'life str>

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.

async_: Option<&'life str>

For classic scripts, if the async attribute is present, then the classic script will be fetched in parallel to parsing and evaluated as soon as it is available.

For module scripts, if the async attribute is present then the scripts and all their dependencies will be executed in the defer queue, therefore they will get fetched in parallel to parsing and evaluated as soon as they are available.

This attribute allows the elimination of parser-blocking JavaScript where the browser would have to load and evaluate scripts before continuing to parse. defer has a similar effect in this case.

This is a boolean attribute: the presence of a boolean attribute on an element represents the true value, and the absence of the attribute represents the false value.

See Browser compatibility for notes on browser support. See also Async scripts for asm.js.

autocapitalize: Option<&'life str>

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<bool>

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.

blocking: Option<&'life str>

This attribute explicitly indicates that certain operations should be blocked on the fetching of the script. The operations that are to be blocked must be a space-separated list of blocking attributes listed below.

• render: The rendering of content on the screen is blocked.

class: Option<&'life str>

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<&'life str>

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<&'life str>

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

crossorigin: Option<&'life str>

Normal script elements pass minimal information to the window.onerror for scripts which do not pass the standard CORS checks. To allow error logging for sites which use a separate domain for static media, use this attribute. See CORS settings attributes for a more descriptive explanation of its valid arguments.

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

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.

defer: Option<&'life str>

This Boolean attribute is set to indicate to a browser that the script is meant to be executed after the document has been parsed, but before firing DOMContentLoaded.

Scripts with the defer attribute will prevent the DOMContentLoaded event from firing until the script has loaded and finished evaluating.

Warning: This attribute must not be used if the src attribute is absent (i.e. for inline scripts), in this case it would have no effect.

The defer attribute has no effect on module scripts — they defer by default.

Scripts with the defer attribute will execute in the order in which they appear in the document.

This attribute allows the elimination of parser-blocking JavaScript where the browser would have to load and evaluate scripts before continuing to parse. async has a similar effect in this case.

dir: Option<&'life str>

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<&'life str>

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<&'life str>

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

exportparts: Option<&'life str>

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

fetchpriority: Option<&'life str>

Provides a hint of the relative priority to use when fetching an external script. Allowed values:

high

Signals a high-priority fetch relative to other external scripts.

low

Signals a low-priority fetch relative to other external scripts.

auto

Default: Signals automatic determination of fetch priority relative to other external scripts.

hidden: Option<bool>

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<&'life str>

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<&'life str>

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

inputmode: Option<&'life str>

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.

integrity: Option<&'life str>

This attribute contains inline metadata that a user agent can use to verify that a fetched resource has been delivered free of unexpected manipulation. See Subresource Integrity.

is: Option<&'life str>

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

nomodule: Option<&'life str>

This Boolean attribute is set to indicate that the script should not be executed in browsers that support ES modules — in effect, this can be used to serve fallback scripts to older browsers that do not support modular JavaScript code.

nonce: Option<&'life str>

A cryptographic nonce (number used once) to allow scripts in a script-src Content-Security-Policy. The server must generate a unique nonce value each time it transmits a policy. It is critical to provide a nonce that cannot be guessed as bypassing a resource's policy is otherwise trivial.

referrerpolicy: Option<&'life str>

Indicates which referrer to send when fetching the script, or resources fetched by the script:

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

Note: An empty string value ("") is both the default value, and a fallback value if referrerpolicy is not supported. If referrerpolicy is not explicitly specified on the <script> element, it will adopt a higher-level referrer policy, i.e. one set on the whole document or domain. If a higher-level policy is not available, the empty string is treated as being equivalent to strict-origin-when-cross-origin.

src: Option<&'life str>

This attribute specifies the URI of an external script; this can be used as an alternative to embedding a script directly within a document.

type_: Option<&'life str>

This attribute indicates the type of script represented. The value of this attribute will be one of the following:

Attribute is not set (default), an empty string, or a JavaScript MIME type

Indicates that the script is a "classic script", containing JavaScript code. Authors are encouraged to omit the attribute if the script refers to JavaScript code rather than specify a MIME type. JavaScript MIME types are listed in the IANA media types specification.

module

This value causes the code to be treated as a JavaScript module. The processing of the script contents is deferred. The charset and defer attributes have no effect. For information on using module, see our JavaScript modules guide. Unlike classic scripts, module scripts require the use of the CORS protocol for cross-origin fetching.

importmap

This value indicates that the body of the element contains an import map. The import map is a JSON object that developers can use to control how the browser resolves module specifiers when importing JavaScript modules.

Any other value

The embedded content is treated as a data block, and won't be processed by the browser. Developers must use a valid MIME type that is not a JavaScript MIME type to denote data blocks. All of the other attributes will be ignored, including the src attribute.

Trait Implementations

impl<'life> Clone for Script<'life>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for Script<'life>

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

Formats the value using the given formatter.

impl<'life> Default for Script<'life>

fn default() -> Script<'life>

Returns the “default value” for a type.

impl<'life> Ord for Script<'life>

fn cmp(&self, other: &Script<'life>) -> 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<'life> PartialEq<Script<'life>> for Script<'life>

fn eq(&self, other: &Script<'life>) -> 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<'life> PartialOrd<Script<'life>> for Script<'life>

fn partial_cmp(&self, other: &Script<'life>) -> 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<'life> Eq for Script<'life>

impl<'life> StructuralEq for Script<'life>

impl<'life> StructuralPartialEq for Script<'life>