Struct moxie_dom::elements::metadata::LinkBuilder

pub struct LinkBuilder { /* fields omitted */ }

The HTML External Resource Link element (<link>) 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.

A type for initializing the element’s attributes before calling build.

Implementations

impl LinkBuilder

pub fn as_(self, to_set: impl ToString) -> Self

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

pub fn crossorigin(self, to_set: impl ToString) -> Self

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.

pub fn disabled(self, to_set: impl ToString) -> Self

For rel=“stylesheet” only, the disabled Boolean attribute indicates whether or not 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.

Once the stylesheet has been loaded, however, changes made to the value of the disabled property no longer have any relationship to the value of the StyleSheet.disabled property. Changing the value of this property instead simply enables and disables the stylesheet form being applied to the document.

This differs from StyleSheet’s disabled property; changing it to true removes the stylesheet from the document’s document.styleSheets list, and doesn’t automatically reload the stylesheet when it’s toggled back to false.

pub fn href(self, to_set: impl ToString) -> Self

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

pub fn hreflang(self, to_set: impl ToString) -> Self

This attribute indicates the language of the linked resource. It is purely advisory. Allowed values are determined by BCP47. Use this attribute only if the href attribute is present.

pub fn media(self, to_set: impl ToString) -> Self

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.

pub fn rel(self, to_set: impl ToString) -> Self

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.

pub fn sizes(self, to_set: impl ToString) -> Self

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 x or X. 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).

pub fn title(self, to_set: impl ToString) -> Self

The title attribute has special semantics on the <link> element. When used on a <link rel="stylesheet"> it defines a preferred or an alternate stylesheet. Incorrectly using it may cause the stylesheet to be ignored.

pub fn type_(self, to_set: impl ToString) -> Self

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.

Trait Implementations

impl ElementBuilder for LinkBuilder

fn attribute(self, name: &'static str, value: impl AsRef<str>) -> Self

Declare an attribute of the element, mutating the actual element’s attribute when the passed value changes.

fn class(self, to_set: impl ToString) -> Self

Updates the element’s class.

fn id(self, to_set: impl ToString) -> Self

Updates the element’s id.

fn style(self, to_set: impl ToString) -> Self

Updates the element’s style.

impl<E> EventTarget<E> for LinkBuilder where
    E: GlobalEvent, 

fn on(self, callback: impl FnMut(Ev) + 'static) -> Self

Declare an event handler on the element.

impl GlobalEventHandler for LinkBuilder

fn onabort(self, callback: impl FnMut(Abort) + 'static) -> Self

Set an event handler.

fn onblur(self, callback: impl FnMut(Blur) + 'static) -> Self

Set an event handler.

fn oncancel(self, callback: impl FnMut(Cancel) + 'static) -> Self

Set an event handler.

fn oncanplay(self, callback: impl FnMut(CanPlay) + 'static) -> Self

Set an event handler.

fn oncanplaythrough(
    self,
    callback: impl FnMut(CanPlayThrough) + 'static
) -> Self

Set an event handler.

fn onchange(self, callback: impl FnMut(Change) + 'static) -> Self

Set an event handler.

fn onclick(self, callback: impl FnMut(Click) + 'static) -> Self

Set an event handler.

fn onclose(self, callback: impl FnMut(CloseWebsocket) + 'static) -> Self

Set an event handler.

fn oncontextmenu(self, callback: impl FnMut(ContextMenu) + 'static) -> Self

Set an event handler.

fn oncuechange(self, callback: impl FnMut(CueChange) + 'static) -> Self

Set an event handler.

fn ondblclick(self, callback: impl FnMut(DoubleClick) + 'static) -> Self

Set an event handler.

fn ondrag(self, callback: impl FnMut(Drag) + 'static) -> Self

Set an event handler.

fn ondragend(self, callback: impl FnMut(DragEnd) + 'static) -> Self

Set an event handler.

fn ondragenter(self, callback: impl FnMut(DragEnter) + 'static) -> Self

Set an event handler.

fn ondragexit(self, callback: impl FnMut(DragExit) + 'static) -> Self

Set an event handler.

fn ondragleave(self, callback: impl FnMut(DragLeave) + 'static) -> Self

Set an event handler.

fn ondragover(self, callback: impl FnMut(DragOver) + 'static) -> Self

Set an event handler.

fn ondragstart(self, callback: impl FnMut(DragStart) + 'static) -> Self

Set an event handler.

fn ondrop(self, callback: impl FnMut(Dropped) + 'static) -> Self

Set an event handler.

fn ondurationchange(
    self,
    callback: impl FnMut(DurationChange) + 'static
) -> Self

Set an event handler.

fn onemptied(self, callback: impl FnMut(Emptied) + 'static) -> Self

Set an event handler.

fn onended(self, callback: impl FnMut(PlaybackEnded) + 'static) -> Self

Set an event handler.

fn onerror(self, callback: impl FnMut(ErrorEvent) + 'static) -> Self

Set an event handler.

fn onfocus(self, callback: impl FnMut(Focus) + 'static) -> Self

Set an event handler.

fn ongotpointercapture(
    self,
    callback: impl FnMut(GotPointerCapture) + 'static
) -> Self

Set an event handler.

fn oninput(self, callback: impl FnMut(Input) + 'static) -> Self

Set an event handler.

fn oninvalid(self, callback: impl FnMut(Invalid) + 'static) -> Self

Set an event handler.

fn onkeydown(self, callback: impl FnMut(KeyDown) + 'static) -> Self

Set an event handler.

fn onkeypress(self, callback: impl FnMut(KeyPress) + 'static) -> Self

Set an event handler.

fn onkeyup(self, callback: impl FnMut(KeyUp) + 'static) -> Self

Set an event handler.

fn onload(self, callback: impl FnMut(ResourceLoad) + 'static) -> Self

Set an event handler.

fn onloadeddata(self, callback: impl FnMut(DataLoaded) + 'static) -> Self

Set an event handler.

fn onloadedmetadata(
    self,
    callback: impl FnMut(MetadataLoaded) + 'static
) -> Self

Set an event handler.

fn onloadend(self, callback: impl FnMut(LoadEnd) + 'static) -> Self

Set an event handler.

fn onloadstart(self, callback: impl FnMut(LoadStart) + 'static) -> Self

Set an event handler.

fn onlostpointercapture(
    self,
    callback: impl FnMut(LostPointerCapture) + 'static
) -> Self

Set an event handler.

fn onmouseenter(self, callback: impl FnMut(MouseEnter) + 'static) -> Self

Set an event handler.

fn onmouseleave(self, callback: impl FnMut(MouseLeave) + 'static) -> Self

Set an event handler.

fn onmousemove(self, callback: impl FnMut(MouseMove) + 'static) -> Self

Set an event handler.

fn onmouseout(self, callback: impl FnMut(MouseOut) + 'static) -> Self

Set an event handler.

fn onmouseover(self, callback: impl FnMut(MouseOver) + 'static) -> Self

Set an event handler.

fn onmouseup(self, callback: impl FnMut(MouseUp) + 'static) -> Self

Set an event handler.

fn onpause(self, callback: impl FnMut(Pause) + 'static) -> Self

Set an event handler.

fn onplay(self, callback: impl FnMut(Play) + 'static) -> Self

Set an event handler.

fn onplaying(self, callback: impl FnMut(Playing) + 'static) -> Self

Set an event handler.

fn onpointercancel(self, callback: impl FnMut(PointerCancel) + 'static) -> Self

Set an event handler.

fn onpointerdown(self, callback: impl FnMut(PointerDown) + 'static) -> Self

Set an event handler.

fn onpointerenter(self, callback: impl FnMut(PointerEnter) + 'static) -> Self

Set an event handler.

fn onpointerleave(self, callback: impl FnMut(PointerLeave) + 'static) -> Self

Set an event handler.

fn onpointermove(self, callback: impl FnMut(PointerMove) + 'static) -> Self

Set an event handler.

fn onpointerout(self, callback: impl FnMut(PointerOut) + 'static) -> Self

Set an event handler.

fn onpointerover(self, callback: impl FnMut(PointerOver) + 'static) -> Self

Set an event handler.

fn onpointerup(self, callback: impl FnMut(PointerUp) + 'static) -> Self

Set an event handler.

fn onprogress(self, callback: impl FnMut(Progress) + 'static) -> Self

Set an event handler.

fn onratechange(
    self,
    callback: impl FnMut(PlaybackRateChange) + 'static
) -> Self

Set an event handler.

fn onreset(self, callback: impl FnMut(FormReset) + 'static) -> Self

Set an event handler.

fn onresize(self, callback: impl FnMut(ViewResize) + 'static) -> Self

Set an event handler.

fn onscroll(self, callback: impl FnMut(Scroll) + 'static) -> Self

Set an event handler.

fn onseeked(self, callback: impl FnMut(Seeked) + 'static) -> Self

Set an event handler.

fn onseeking(self, callback: impl FnMut(Seeking) + 'static) -> Self

Set an event handler.

fn onselect(self, callback: impl FnMut(Select) + 'static) -> Self

Set an event handler.

fn onselectionchange(
    self,
    callback: impl FnMut(SelectionChange) + 'static
) -> Self

Set an event handler.

fn onselectstart(self, callback: impl FnMut(SelectionStart) + 'static) -> Self

Set an event handler.

fn onshow(self, callback: impl FnMut(ContextMenuShow) + 'static) -> Self

Set an event handler.

fn onstalled(self, callback: impl FnMut(Stalled) + 'static) -> Self

Set an event handler.

fn onsubmit(self, callback: impl FnMut(Submit) + 'static) -> Self

Set an event handler.

fn onsuspend(self, callback: impl FnMut(Suspend) + 'static) -> Self

Set an event handler.

fn ontimeupdate(self, callback: impl FnMut(TimeUpdate) + 'static) -> Self

Set an event handler.

fn onvolumechange(self, callback: impl FnMut(VolumeChange) + 'static) -> Self

Set an event handler.

fn onwaiting(self, callback: impl FnMut(Waiting) + 'static) -> Self

Set an event handler.

fn onwheel(self, callback: impl FnMut(Wheel) + 'static) -> Self

Set an event handler.

impl HtmlElementBuilder for LinkBuilder

fn accesskey(self, to_set: impl ToString) -> Self

Keyboard shortcut to activate or add focus to the element.

fn autocapitalize(self, to_set: impl ToString) -> Self

Sets whether input is automatically capitalized when entered by user. It can have the following values:

fn contenteditable(self, to_set: bool) -> Self

A value of “true” means the element is editable and a value of “false” means it isn’t.

fn dir(self, to_set: impl ToString) -> Self

The directionality of the element. It can have the following values:

fn draggable(self, to_set: bool) -> Self

Defines whether the element can be dragged.

fn hidden(self, to_set: bool) -> Self

Indicates if the element is hidden or not.

fn inert(self, to_set: bool) -> Self

Indicates whether the user agent must act as though the given node is absent for the purposes of user interaction events, in-page text searches (“find in page”), and text selection.

fn inputmode(self, to_set: impl ToString) -> Self

Provides a hint as to the type of data that might be entered by the user while editing the element or its contents. The attribute can be used with form controls (such as the value of textarea elements), or in elements in an editing host (e.g., using contenteditable attribute).

fn lang(self, to_set: impl ToString) -> Self

The language of an element’s attributes, text, and element contents.

fn slot(self, to_set: impl ToString) -> Self

Assigns a slot in a shadow DOM shadow tree to an element.

fn spellcheck(self, to_set: impl ToString) -> Self

Indicates whether spell checking is allowed for the element.

fn tabindex(self, to_set: impl ToString) -> Self

Overrides the browser’s default tab order and follows the one specified instead.

fn title(self, to_set: impl ToString) -> Self

The text that appears in a popup box when mouse is over the element.

impl NodeBuilder for LinkBuilder

fn build(self) -> Link

Initialize the element with all of the attributes so far.

type Output = Link

The type of the DOM node

impl NodeWrapper for LinkBuilder

fn raw_node_that_has_sharp_edges_please_be_careful(&self) -> &Node

Retrieves access to the raw HTML element underlying the (CachedNode).