Struct html_tags::Link

source ·
pub struct Link<'life> {
Show 34 fields pub accesskey: Option<&'life str>, pub as_: 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 dir: Option<&'life str>, pub disabled: Option<bool>, 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 href: Option<&'life str>, pub hreflang: Option<&'life str>, pub id: Option<&'life str>, pub imagesizes: Option<&'life str>, pub imagesrcset: Option<&'life str>, pub inert: Option<&'life str>, pub inputmode: Option<&'life str>, pub integrity: Option<&'life str>, pub is: Option<&'life str>, pub media: Option<&'life str>, pub prefetch: Option<&'life str>, pub referrerpolicy: Option<&'life str>, pub rel: Option<&'life str>, pub sizes: Option<&'life str>, pub title: Option<&'life str>, pub type_: Option<&'life str>, pub extra: BTreeMap<&'life str, &'life str>,
}
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<&'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.

§as_: Option<&'life str>

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

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

§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.
§disabled: Option<bool>

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<&'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 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<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.

§href: Option<&'life str>

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

§hreflang: Option<&'life str>

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

§imagesizes: Option<&'life str>

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

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

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

§media: Option<&'life str>

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.
§prefetch: Option<&'life str>

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

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

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.

§sizes: Option<&'life str>

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

§title: Option<&'life str>

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.

§type_: Option<&'life str>

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.

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

The extra attributes of the element. This is a map of attribute names to their values. The attribute names are in 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) -> Selfwhere Self: Sized,

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

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

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

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

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

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

source§

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

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

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

impl<'life> PartialOrd<Link<'life>> 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

This method 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

This method 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

This method 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

This method 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> StructuralEq for Link<'life>

source§

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

Auto Trait Implementations§

§

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 Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.