Struct Link

Source
pub struct Link<'life> {
Show 50 fields pub accesskey: Option<AttributeValue<'life>>, pub as_: Option<AttributeValue<'life>>, pub autocapitalize: Option<AttributeValue<'life>>, pub autofocus: Option<AttributeValue<'life>>, pub blocking: Option<AttributeValue<'life>>, pub class: Option<AttributeValue<'life>>, pub contenteditable: Option<AttributeValue<'life>>, pub contextmenu: Option<AttributeValue<'life>>, pub crossorigin: Option<AttributeValue<'life>>, pub data: BTreeMap<&'life str, AttributeValue<'life>>, pub dir: Option<AttributeValue<'life>>, pub disabled: 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 fetchpriority: Option<AttributeValue<'life>>, pub hidden: Option<AttributeValue<'life>>, pub href: Option<AttributeValue<'life>>, pub hreflang: Option<AttributeValue<'life>>, pub id: Option<AttributeValue<'life>>, pub imagesizes: Option<AttributeValue<'life>>, pub imagesrcset: Option<AttributeValue<'life>>, pub inert: Option<AttributeValue<'life>>, pub inputmode: Option<AttributeValue<'life>>, pub integrity: 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 media: Option<AttributeValue<'life>>, pub nonce: Option<AttributeValue<'life>>, pub part: Option<AttributeValue<'life>>, pub popover: Option<AttributeValue<'life>>, pub prefetch: Option<AttributeValue<'life>>, pub referrerpolicy: Option<AttributeValue<'life>>, pub rel: Option<AttributeValue<'life>>, pub role: Option<AttributeValue<'life>>, pub sizes: Option<AttributeValue<'life>>, pub slot: Option<AttributeValue<'life>>, pub spellcheck: Option<AttributeValue<'life>>, pub style: Option<AttributeValue<'life>>, pub tabindex: Option<AttributeValue<'life>>, pub title: Option<AttributeValue<'life>>, pub translate: Option<AttributeValue<'life>>, pub type_: Option<AttributeValue<'life>>, pub virtualkeyboardpolicy: Option<AttributeValue<'life>>,
}
Expand description

The <link> HTML element specifies relationships between the current document and an external resource. This element is most commonly used to link to stylesheets, but is also used to establish site icons (both “favicon” style icons and icons for the home screen and apps on mobile devices) among other things.

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

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.

§as_: Option<AttributeValue<'life>>

This attribute is only used when rel="preload" or rel="prefetch" has been set on the <link> element. It specifies the type of content being loaded by the <link>, which is necessary for request matching, application of correct content security policy, and setting of correct Accept request header. Furthermore, rel="preload" uses this as a signal for request prioritization. The table below lists the valid values for this attribute and the elements or resources they apply to.

Value Applies To
audio <audio> elements
document <iframe> and <frame> elements
embed <embed> elements
fetch

fetch, XHR

Note: This value also requires <link> to contain the crossorigin attribute.

font CSS @font-face
image <img> and <picture> elements with srcset or imageset attributes, SVG <image> elements, CSS *-image rules
object <object> elements
script <script> elements, Worker importScripts
style <link rel=stylesheet> elements, CSS @import
track <track> elements
video <video> elements
worker Worker, SharedWorker
§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.

§blocking: Option<AttributeValue<'life>>

This attribute explicitly indicates that certain operations should be blocked on the fetching of an external resource. 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<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.

§crossorigin: Option<AttributeValue<'life>>

This enumerated attribute indicates whether CORS must be used when fetching the resource. CORS-enabled images can be reused in the <canvas> element without being tainted. The allowed values are:

anonymous

A cross-origin request (i.e. with an Origin HTTP header) is performed, but no credential is sent (i.e. no cookie, X.509 certificate, or HTTP Basic authentication). If the server does not give credentials to the origin site (by not setting the Access-Control-Allow-Origin HTTP header) the resource will be tainted and its usage restricted.

use-credentials

A cross-origin request (i.e. with an Origin HTTP header) is performed along with a credential sent (i.e. a cookie, certificate, and/or HTTP Basic authentication is performed). If the server does not give credentials to the origin site (through Access-Control-Allow-Credentials HTTP header), the resource will be tainted and its usage restricted.

If the attribute is not present, the resource is fetched without a CORS request (i.e. without sending the Origin HTTP header), preventing its non-tainted usage. If invalid, it is handled as if the enumerated keyword anonymous was used. See CORS settings attributes for additional information.

§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.
§disabled: Option<AttributeValue<'life>>

For rel="stylesheet" only, the disabled Boolean attribute indicates whether the described stylesheet should be loaded and applied to the document. If disabled is specified in the HTML when it is loaded, the stylesheet will not be loaded during page load. Instead, the stylesheet will be loaded on-demand, if and when the disabled attribute is changed to false or removed.

Setting the disabled property in the DOM causes the stylesheet to be removed from the document's Document.styleSheets list.

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

§fetchpriority: Option<AttributeValue<'life>>

Provides a hint of the relative priority to use when fetching a preloaded resource. Allowed values:

high

Signals a high-priority fetch relative to other resources of the same type.

low

Signals a low-priority fetch relative to other resources of the same type.

auto

Default: Signals automatic determination of fetch priority relative to other resources of the same type.

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

§href: Option<AttributeValue<'life>>

This attribute specifies the URL of the linked resource. A URL can be absolute or relative.

§hreflang: Option<AttributeValue<'life>>

This attribute indicates the language of the linked resource. It is purely advisory. Allowed values are specified by RFC 5646: Tags for Identifying Languages (also known as BCP 47). Use this attribute only if the href attribute is present.

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

§imagesizes: Option<AttributeValue<'life>>

For rel="preload" and as="image" only, the imagesizes attribute is a sizes attribute that indicates to preload the appropriate resource used by an img element with corresponding values for its srcset and sizes attributes.

§imagesrcset: Option<AttributeValue<'life>>

For rel="preload" and as="image" only, the imagesrcset attribute is a sourceset attribute that indicates to preload the appropriate resource used by an img element with corresponding values for its srcset and sizes attributes.

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

§integrity: Option<AttributeValue<'life>>

Contains inline metadata — a base64-encoded cryptographic hash of the resource (file) you're telling the browser to fetch. The browser can use this to verify that the fetched resource has been delivered free of unexpected manipulation. See Subresource Integrity.

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

§media: Option<AttributeValue<'life>>

This attribute specifies the media that the linked resource applies to. Its value must be a media type / media query. This attribute is mainly useful when linking to external stylesheets — it allows the user agent to pick the best adapted one for the device it runs on.

Note:

  • In HTML 4, this can only be a simple white-space-separated list of media description literals, i.e., media types and groups, where defined and allowed as values for this attribute, such as print, screen, aural, braille. HTML5 extended this to any kind of media queries, which are a superset of the allowed values of HTML 4.
  • Browsers not supporting CSS Media Queries won't necessarily recognize the adequate link; do not forget to set fallback links, the restricted set of media queries defined in HTML 4.
§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().

§prefetch: Option<AttributeValue<'life>>

Identifies a resource that might be required by the next navigation and that the user agent should retrieve it. This allows the user agent to respond faster when the resource is requested in the future.

§referrerpolicy: Option<AttributeValue<'life>>

A string indicating which referrer to use when fetching the resource:

  • no-referrer means that the Referer header will not be sent.
  • no-referrer-when-downgrade means that no Referer header will be sent when navigating to an origin without TLS (HTTPS). This is a user agent's default behavior, if no policy is otherwise specified.
  • origin means that the referrer will be the origin of the page, which is roughly the scheme, the host, and the port.
  • origin-when-cross-origin means that navigating to other origins will be limited to the scheme, the host, and the port, while navigating on the same origin will include the referrer's path.
  • unsafe-url means that the referrer will include the origin and the path (but not the fragment, password, or username). This case is unsafe because it can leak origins and paths from TLS-protected resources to insecure origins.
§rel: Option<AttributeValue<'life>>

This attribute names a relationship of the linked document to the current document. The attribute must be a space-separated list of link type values.

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

§sizes: Option<AttributeValue<'life>>

This attribute defines the sizes of the icons for visual media contained in the resource. It must be present only if the rel contains a value of icon or a non-standard type such as Apple's apple-touch-icon. It may have the following values:

  • any, meaning that the icon can be scaled to any size as it is in a vector format, like image/svg+xml.
  • a white-space separated list of sizes, each in the format <width in pixels>x<height in pixels> or <width in pixels>X<height in pixels>. Each of these sizes must be contained in the resource.

Note: Most icon formats are only able to store one single icon; therefore, most of the time, the sizes attribute contains only one entry. MS's ICO format does, as well as Apple's ICNS. ICO is more ubiquitous, so you should use this format if cross-browser support is a concern (especially for old IE versions).

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

The title attribute has special semantics on the <link> element. When used on a <link rel="stylesheet"> it defines a default or an alternate stylesheet.

§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.
§type_: Option<AttributeValue<'life>>

This attribute is used to define the type of the content linked to. The value of the attribute should be a MIME type such as text/html, text/css, and so on. The common use of this attribute is to define the type of stylesheet being referenced (such as text/css), but given that CSS is the only stylesheet language used on the web, not only is it possible to omit the type attribute, but is actually now recommended practice. It is also used on rel="preload" link types, to make sure the browser only downloads file types that it supports.

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

Implementations§

Source§

impl<'life> Link<'life>

Source

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.

Source

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§

Source§

impl<'life> Clone for Link<'life>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'life> Debug for Link<'life>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'life> Default for Link<'life>

Source§

fn default() -> Link<'life>

Returns the “default value” for a type. Read more
Source§

impl<'life> Ord for Link<'life>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<'life> PartialEq for Link<'life>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'life> PartialOrd for Link<'life>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<'life> Eq for Link<'life>

Source§

impl<'life> StructuralPartialEq for Link<'life>

Auto Trait Implementations§

§

impl<'life> Freeze for Link<'life>

§

impl<'life> RefUnwindSafe for Link<'life>

§

impl<'life> Send for Link<'life>

§

impl<'life> Sync for Link<'life>

§

impl<'life> Unpin for Link<'life>

§

impl<'life> UnwindSafe for Link<'life>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.