Struct bloguen::ops::WrappedElementImpl

pub struct WrappedElementImpl<Dt: WrappedElementImplData>(_, _);

A semi-generic wrapped data specifier, backing ScriptElement and StyleElement.

Methods

impl<Dt: WrappedElementImplData> WrappedElementImpl<Dt>

pub fn from_link<DtF: Into<Cow<'static, str>>>(link: DtF) -> Self

Create an element linking to an external resource.

Examples

let lonk = ScriptElement::from_link("/content/assets/syllable.js");
assert_eq!(
    format!("{}{}{}", lonk.head(), lonk.content(), lonk.foot()),
    "<script type=\"text/javascript\" src=\"/content/assets/syllable.js\"></script>\n")

let lonk = StyleElement::from_link("//nabijaczleweli.xyz/kaschism/assets/column.css");
assert_eq!(
    format!("{}{}{}", lonk.head(), lonk.content(), lonk.foot()),
    "<link href=\"//nabijaczleweli.xyz/kaschism/assets/column.css\" rel=\"stylesheet\" />\n")

pub fn from_literal<DtF: Into<Cow<'static, str>>>(literal: DtF) -> Self

Create an element including the specified literal literally.

Examples

let lit = ScriptElement::from_literal("document.getElementById(\"title\").innerText = \"Наган\";");
assert_eq!(
    format!("{}{}{}", lit.head(), lit.content(), lit.foot()),
    "<script type=\"text/javascript\">\n\ndocument.getElementById(\"title\").innerText = \"Наган\";\n\n</script>\n")

let lit = StyleElement::from_literal(".indented { text-indent: 1em; }");
assert_eq!(
    format!("{}{}{}", lit.head(), lit.content(), lit.foot()),
    "<style type=\"text/css\">\n\n.indented { text-indent: 1em; }\n\n</style>\n")

pub fn from_path<DtF: Into<Cow<'static, str>>>(path: DtF) -> Self

Create an element pointing to the specified relative path.

Consult load() documentation for more data.

Examples

Given $ROOT/MathJax-config.js containing:

MathJax.Hub.Config({
  jax: ["input/AsciiMath", "output/HTML-CSS"],
  extensions: ["asciimath2jax.js"],
  asciimath2jax: {
    delimiters: [['[​[​', '​]​]']],
    preview: "[[maths]]"
  },
  AsciiMath: {
    decimal: "."
  },
  "HTML-CSS": {
    undefinedFamily: "STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif"
  }
});

The following holds:

let root: PathBuf = /* obtained elsewhere */;

let mut lit_p = ScriptElement::from_path("MathJax-config.js");
assert_eq!(lit_p.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(format!("{}{}{}", lit_p.head(), lit_p.content(), lit_p.foot()),
"<script type=\"text/javascript\">\n\n\
    MathJax.Hub.Config({\n\
      jax: [\"input/AsciiMath\", \"output/HTML-CSS\"],\n\
      extensions: [\"asciimath2jax.js\"],\n\
      asciimath2jax: {\n\
        delimiters: [['[​[​', '​]​]']],\n\
        preview: \"[[maths]]\"\n\
      },\n\
      AsciiMath: {\n\
        decimal: \".\"\n\
      },\n\
      \"HTML-CSS\": {\n\
        undefinedFamily: \"STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif\"\n\
      }\n\
    });\n\
\n\n</script>\n");

Given $ROOT/common.css containing:

ul, ol {
    margin-top: 0;
    margin-bottom: 0;
}

a > i.fa {
    color: black;
}

The following holds:

let root: PathBuf = /* obtained elsewhere */;

let mut lit_p = StyleElement::from_path("common.css");
assert_eq!(lit_p.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(format!("{}{}{}", lit_p.head(), lit_p.content(), lit_p.foot()),
"<style type=\"text/css\">\n\n\
     ul, ol {\n\
         margin-top: 0;\n\
         margin-bottom: 0;\n\
     }\n\
     \n\
     a > i.fa {\n\
         color: black;\n\
     }\n\n\
\n\n</style>\n");

pub fn from_file(path: &(String, PathBuf)) -> Result<Self, Error>

Create a literal script element from the contents of the specified file.

Examples

Given $ROOT/MathJax-config.js containing:

MathJax.Hub.Config({
  jax: ["input/AsciiMath", "output/HTML-CSS"],
  extensions: ["asciimath2jax.js"],
  asciimath2jax: {
    delimiters: [['[​[​', '​]​]']],
    preview: "[[maths]]"
  },
  AsciiMath: {
    decimal: "."
  },
  "HTML-CSS": {
    undefinedFamily: "STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif"
  }
});

The following holds:

let root: PathBuf = /* obtained elsewhere */;

let lit_p = ScriptElement::from_file(&("$ROOT/MathJax-config.js".to_string(), root.join("MathJax-config.js"))).unwrap();
assert_eq!(format!("{}{}{}", lit_p.head(), lit_p.content(), lit_p.foot()),
"<script type=\"text/javascript\">\n\n\
    MathJax.Hub.Config({\n\
      jax: [\"input/AsciiMath\", \"output/HTML-CSS\"],\n\
      extensions: [\"asciimath2jax.js\"],\n\
      asciimath2jax: {\n\
        delimiters: [['[​[​', '​]​]']],\n\
        preview: \"[[maths]]\"\n\
      },\n\
      AsciiMath: {\n\
        decimal: \".\"\n\
      },\n\
      \"HTML-CSS\": {\n\
        undefinedFamily: \"STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif\"\n\
      }\n\
    });\n\
\n\n</script>\n");

Given $ROOT/common.css containing:

ul, ol {
    margin-top: 0;
    margin-bottom: 0;
}

a > i.fa {
    color: black;
}

The following holds:

let root: PathBuf = /* obtained elsewhere */;

let lit_p = StyleElement::from_file(&("$ROOT/common.css".to_string(), root.join("common.css"))).unwrap();
assert_eq!(format!("{}{}{}", lit_p.head(), lit_p.content(), lit_p.foot()),
"<style type=\"text/css\">\n\n\
     ul, ol {\n\
         margin-top: 0;\n\
         margin-bottom: 0;\n\
     }\n\
     \n\
     a > i.fa {\n\
         color: black;\n\
     }\n\n\
\n\n</style>\n");

pub fn load(&mut self, base: &(String, PathBuf)) -> Result<(), Error>

Read data from the filesystem, if appropriate.

Path elements are concatenated with the specified root, then read_file()d in, becoming literals.

Non-path elements are unaffected.

Examples

Given the following directory layout:

$ROOT
  MathJax-config.js
  assets
    octicons.js

Given $ROOT/MathJax-config.js containing:

MathJax.Hub.Config({
  jax: ["input/AsciiMath", "output/HTML-CSS"],
  extensions: ["asciimath2jax.js"],
  asciimath2jax: {
    delimiters: [['[​[​', '​]​]']],
    preview: "[[maths]]"
  },
  AsciiMath: {
    decimal: "."
  },
  "HTML-CSS": {
    undefinedFamily: "STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif"
  }
});

Given $ROOT/assets/octicons.js containing:

window.addEventListener("load", function() {
    const PLACEHOLDER = document.getElementById("octicons-placeholder");

    const request = new XMLHttpRequest();
    request.open("GET", "/content/assets/octicons/sprite.octicons.svg");
    request.onload = function(load) {
        PLACEHOLDER.outerHTML = load.target.responseText.replace("<svg", "<svg class=\"hidden\"");
    };
    request.send();
});

The following holds:

function() {\n\
let root: PathBuf = /* obtained elsewhere */;

let mut elem = ScriptElement::from_path("MathJax-config.js");
assert_eq!(elem.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(elem, ScriptElement::from_literal("\
    MathJax.Hub.Config({\n\
      jax: [\"input/AsciiMath\", \"output/HTML-CSS\"],\n\
      extensions: [\"asciimath2jax.js\"],\n\
      asciimath2jax: {\n\
        delimiters: [['[​[​', '​]​]']],\n\
        preview: \"[[maths]]\"\n\
      },\n\
      AsciiMath: {\n\
        decimal: \".\"\n\
      },\n\
      \"HTML-CSS\": {\n\
        undefinedFamily: \"STIXGeneral,'DejaVu Sans Mono','Arial Unicode MS',serif\"\n\
      }\n\
    });\n\
"));

let mut elem = ScriptElement::from_path("assets/.././assets/octicons.js");
assert_eq!(elem.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(elem, ScriptElement::from_literal("\
window.addEventListener(\"load\", function() {\n\
    const PLACEHOLDER = document.getElementById(\"octicons-placeholder\");\n\
    \n\
    const request = new XMLHttpRequest();\n\
    request.open(\"GET\", \"/content/assets/octicons/sprite.octicons.svg\");\n\
    request.onload = function(load) {\n\
        PLACEHOLDER.outerHTML = load.target.responseText.replace(\"

Given the following directory layout:

$ROOT
  common.css
  assets
    effects.css

Given $ROOT/common.css containing:

ul, ol {
    margin-top: 0;
    margin-bottom: 0;
}

a > i.fa {
    color: black;
}

Given $ROOT/assets/effects.css containing:

.ruby {
    /* That's Ruby according to https://en.wikipedia.org/wiki/Ruby_(color). */
    color: #E0115F;
}

The following holds:

let root: PathBuf = /* obtained elsewhere */;

let mut elem = StyleElement::from_path("common.css");
assert_eq!(elem.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(elem, StyleElement::from_literal("\
    ul, ol {\n\
        margin-top: 0;\n\
        margin-bottom: 0;\n\
    }\n\
    \n\
    a > i.fa {\n\
        color: black;\n\
    }\n
"));

let mut elem = StyleElement::from_path("assets/.././assets/effects.css");
assert_eq!(elem.load(&("$ROOT".to_string(), root.clone())), Ok(()));
assert_eq!(elem, StyleElement::from_literal("\
   .ruby {\n\
        /* That's Ruby according to https://en.wikipedia.org/wiki/Ruby_(color). */\n\
        color: #E0115F;\n\
    }\n
"));

let mut elem = StyleElement::from_path("assets/nonexistant.css");
assert_eq!(elem.load(&("$ROOT".to_string(), root.clone())), Err(Error::FileNotFound {
    who: "file style element",
    path: "$ROOT/assets/nonexistant.css".into(),
}));
assert_eq!(elem, StyleElement::from_path("assets/nonexistant.css"));

Trait Implementations

impl<Dt: WrappedElementImplData> WrappedElement for WrappedElementImpl<Dt>

fn head(&self) -> &str

Characters to put before the content.

fn content(&self) -> &str

The content itself.

fn foot(&self) -> &str

Characters to put after the content.

fn head_b(&self) -> &[u8]

Byte representation of pre-content.

fn content_b(&self) -> &[u8]

Byte representation of the content.

fn foot_b(&self) -> &[u8]

Byte representation of post-content.

impl<Dt: Eq + WrappedElementImplData> Eq for WrappedElementImpl<Dt>

impl<Dt: Clone + WrappedElementImplData> Clone for WrappedElementImpl<Dt>

fn clone(&self) -> WrappedElementImpl<Dt>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Dt: PartialOrd + WrappedElementImplData> PartialOrd<WrappedElementImpl<Dt>> for WrappedElementImpl<Dt>

fn partial_cmp(&self, other: &WrappedElementImpl<Dt>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WrappedElementImpl<Dt>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WrappedElementImpl<Dt>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WrappedElementImpl<Dt>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WrappedElementImpl<Dt>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Dt: PartialEq + WrappedElementImplData> PartialEq<WrappedElementImpl<Dt>> for WrappedElementImpl<Dt>

fn eq(&self, other: &WrappedElementImpl<Dt>) -> bool

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

fn ne(&self, other: &WrappedElementImpl<Dt>) -> bool

This method tests for !=.

impl<Dt: Ord + WrappedElementImplData> Ord for WrappedElementImpl<Dt>

fn cmp(&self, other: &WrappedElementImpl<Dt>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Dt: Hash + WrappedElementImplData> Hash for WrappedElementImpl<Dt>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<Dt: Debug + WrappedElementImplData> Debug for WrappedElementImpl<Dt>

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

Formats the value using the given formatter.

impl<'de, Dt: WrappedElementImplData> Deserialize<'de> for WrappedElementImpl<Dt>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.