Struct html_tags::A

pub struct A<'life> {

    pub accesskey: Option<&'life str>,
    pub autocapitalize: Option<&'life str>,
    pub autofocus: Option<bool>,
    pub class: Option<&'life str>,
    pub contenteditable: Option<&'life str>,
    pub contextmenu: Option<&'life str>,
    pub data: Option<BTreeMap<&'life str, &'life str>>,
    pub dir: Option<&'life str>,
    pub download: Option<&'life str>,
    pub draggable: Option<&'life str>,
    pub enterkeyhint: Option<&'life str>,
    pub exportparts: Option<&'life str>,
    pub hidden: Option<bool>,
    pub href: Option<&'life str>,
    pub hreflang: Option<&'life str>,
    pub id: Option<&'life str>,
    pub inert: Option<&'life str>,
    pub inputmode: Option<&'life str>,
    pub is: Option<&'life str>,
    pub ping: Option<&'life str>,
    pub referrerpolicy: Option<&'life str>,
    pub rel: Option<&'life str>,
    pub target: Option<&'life str>,
    pub type_: Option<&'life str>,
}

The <a> HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.

Content within each <a> should indicate the link’s destination. If the href attribute is present, pressing the enter key while focused on the <a> element will activate it.

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

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.

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.

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.

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.

download: Option<&'life str>

Causes the browser to treat the linked URL as a download. Can be used with or without a filename value:

• Without a value, the browser will suggest a filename/extension, generated from various sources:
  • The Content-Disposition HTTP header
  • The final segment in the URL path
  • The media type (from the Content-Type header, the start of a data: URL, or Blob.type for a blob: URL)
• filename: defining a value suggests it as the filename. / and \ characters are converted to underscores (_). Filesystems may forbid other characters in filenames, so browsers will adjust the suggested name if necessary.

Note:

• download only works for same-origin URLs, or the blob: and data: schemes.
• How browsers treat downloads varies by browser, user settings, and other factors. The user may be prompted before a download starts, or the file may be saved automatically, or it may open automatically, either in an external application or in the browser itself.
• If the Content-Disposition header has different information from the download attribute, resulting behavior may differ:
  • If the header specifies a filename, it takes priority over a filename specified in the download attribute.
  • If the header specifies a disposition of inline, Chrome and Firefox prioritize the attribute and treat it as a download. Old Firefox versions (before 82) prioritize the header and will display the content inline.

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.

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>

The URL that the hyperlink points to. Links are not restricted to HTTP-based URLs — they can use any URL scheme supported by browsers:

• Sections of a page with document fragments
• Specific text portions with text fragments
• Pieces of media files with media fragments
• Telephone numbers with tel: URLs
• Email addresses with mailto: URLs
• While web browsers may not support other URL schemes, websites can with registerProtocolHandler()

hreflang: Option<&'life str>

Hints at the human language of the linked URL. No built-in functionality. Allowed values are the same as the global lang attribute.

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.

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

ping: Option<&'life str>

A space-separated list of URLs. When the link is followed, the browser will send POST requests with the body PING to the URLs. Typically for tracking.

referrerpolicy: Option<&'life str>

How much of the referrer to send when following the link.

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

rel: Option<&'life str>

The relationship of the linked URL as space-separated link types.

target: Option<&'life str>

Where to display the linked URL, as the name for a browsing context (a tab, window, or <iframe>). The following keywords have special meanings for where to load the URL:

• _self: the current browsing context. (Default)
• _blank: usually a new tab, but users can configure browsers to open a new window instead.
• _parent: the parent browsing context of the current one. If no parent, behaves as _self.
• _top: the topmost browsing context (the "highest" context that's an ancestor of the current one). If no ancestors, behaves as _self.

Note: Setting target="_blank" on <a> elements implicitly provides the same rel behavior as setting rel="noopener" which does not set window.opener.

type_: Option<&'life str>

Hints at the linked URL's format with a MIME type. No built-in functionality.

Trait Implementations

impl<'life> Clone for A<'life>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for A<'life>

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

Formats the value using the given formatter.

impl<'life> Default for A<'life>

fn default() -> A<'life>

Returns the “default value” for a type.

impl<'life> Ord for A<'life>

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

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

fn partial_cmp(&self, other: &A<'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 A<'life>

impl<'life> StructuralEq for A<'life>

impl<'life> StructuralPartialEq for A<'life>