Struct HmrMessage 

pub struct HmrMessage {
    pub kind: HmrType,
    pub paths: Vec<String>,
    pub sha: String,
}

A single HMR frame.

Fields

kind: HmrType

Frame type.

paths: Vec<String>

Paths affected. For hmr-html these are page URLs; for hmr-css these are asset URLs; for reload this may be empty.

sha: String

Short content hash. Optional — empty string is fine.

Implementations

impl HmrMessage

pub const fn css(paths: Vec<String>) -> Self

Build a CSS-swap frame for one or more stylesheet paths.

Examples

use ssg::hmr::{HmrMessage, HmrType};
let m = HmrMessage::css(vec!["x.css".into()]);
assert_eq!(m.kind, HmrType::HmrCss);
assert_eq!(m.paths, vec!["x.css"]);

pub const fn html(paths: Vec<String>) -> Self

Build an HTML-partial frame for one or more page URLs.

Examples

use ssg::hmr::{HmrMessage, HmrType};
let m = HmrMessage::html(vec!["/a/".into()]);
assert_eq!(m.kind, HmrType::HmrHtml);

pub const fn reload() -> Self

Build a full-page-reload frame.

Examples

use ssg::hmr::{HmrMessage, HmrType};
let m = HmrMessage::reload();
assert_eq!(m.kind, HmrType::Reload);
assert!(m.paths.is_empty());

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

Attach a content hash for client-side de-duplication.

Examples

use ssg::hmr::HmrMessage;
let m = HmrMessage::reload().with_sha("abc123");
assert_eq!(m.sha, "abc123");

pub fn to_json(&self) -> String

Serialise to the JSON wire format. Infallible — the struct is always serialisable.

Panics

Only if serde_json cannot serialise a primitive Vec<String>, which is impossible.

Examples

use ssg::hmr::HmrMessage;
let m = HmrMessage::css(vec!["a.css".into()]);
let json = m.to_json();
assert!(json.contains("\"type\":\"hmr-css\""));

Trait Implementations

impl Clone for HmrMessage

fn clone(&self) -> HmrMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HmrMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HmrMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HmrMessage

impl PartialEq for HmrMessage

fn eq(&self, other: &HmrMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HmrMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HmrMessage