Struct Tag 

pub struct Tag<'a> { /* private fields */ }

The script tag for one page. Get one with Config::tag.

Every setting can be changed for this page only, and page props set here are merged over the configured ones. A Value::Null (or None) removes one.

use privatus_analytics::{props, Config};

let config = Config::new().site_id("pa_YOURSITEID").enabled(true);
let html = config
    .tag()
    .modules(["engage", "auto"])
    .props(props! { "plan" => "pro" })
    .nonce("r4nd0m")
    .to_html();
assert!(html.as_str().contains(r#"data-modules="engage,auto""#));

Tag implements Display, so format!("{tag}") and {{ tag }} style templates print the HTML without escaping it again.

Implementations

impl<'a> Tag<'a>

pub fn new(config: &'a Config) -> Self

The tag for these settings.

pub fn site_id(self, site_id: impl Into<String>) -> Self

Uses another site id on this page.

pub fn script_host(self, host: impl Into<String>) -> Self

Uses another script host on this page.

pub fn modules<I, S>(self, modules: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Loads these modules on this page.

pub fn excluded_paths<I, S>(self, paths: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Uses these excluded paths on this page.

pub fn domains<I, S>(self, domains: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Uses these domains on this page.

pub fn spa(self, spa: Spa) -> Self

Uses this single-page app mode on this page.

pub fn manual(self, manual: bool) -> Self

Turns manual mode on or off on this page.

pub fn enabled(self, enabled: bool) -> Self

Forces the tag on or off on this page.

pub fn extra_attribute( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Adds or replaces one extra attribute on this page.

pub fn queue_stub(self, queue_stub: bool) -> Self

Prints the queue stub on this page, or not.

pub fn nonce(self, nonce: impl Into<String>) -> Self

The Content Security Policy nonce for the scripts.

pub fn props<I, K, V>(self, props: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: Into<Value>,

Merges page props over the configured ones. A Value::Null (or None) removes a prop. Can be called more than once.

pub fn config(&self) -> &Config

The settings this tag uses, with the per-page changes.

pub fn will_render(&self) -> bool

Whether the tracker prints: there is a site id and the tag is on. When this is false, Tag::to_html prints at most the queue stub.

pub fn page_props(&self) -> Vec<(String, Value)>

The configured props with the per-page props merged on top. Keys are cleaned. Null values are still in the list.

pub fn attributes(&self) -> Vec<(String, Option<String>)>

The tracker tag’s attributes in order. None is an attribute with no value (defer).

pub fn to_html(&self) -> SafeHtml

The HTML: the queue stub (when on), the page props script (when there are props), then the tracker tag, one per line.

When the tag is off or there is no site id, it is only the queue stub (when on, with the nonce), so privatus.track calls in your own JavaScript never fail; or empty when the stub is off. No tracker and no page props script print then.

Trait Implementations

impl<'a> Clone for Tag<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Tag<'a>

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

Formats the value using the given formatter.

impl Display for Tag<'_>

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

Formats the value using the given formatter.

impl From<Tag<'_>> for SafeHtml

fn from(tag: Tag<'_>) -> SafeHtml

Converts to this type from the input type.

impl HtmlSafe for Tag<'_>

Available on crate feature askama only.

impl Render for Tag<'_>

Available on crate feature maud only.

fn render_to(&self, buffer: &mut String)

Appends a representation of self to the given buffer.

fn render(&self) -> PreEscaped<String>

Renders self as a block of Markup.