Struct LiveReloadPlugin 

pub struct LiveReloadPlugin { /* private fields */ }

Plugin that injects a live-reload script into all HTML files.

The injected script opens a WebSocket connection and reloads the page when it receives a "reload" message. It reconnects automatically with exponential backoff on disconnect.

Example

use ssg::plugin::PluginManager;
use ssg::livereload::LiveReloadPlugin;

let mut pm = PluginManager::new();
pm.register(LiveReloadPlugin::new());

Implementations

impl LiveReloadPlugin

pub const fn new() -> Self

Creates a new LiveReloadPlugin with the default port (35729).

Examples

use ssg::livereload::{LiveReloadPlugin, DEFAULT_PORT};

let p = LiveReloadPlugin::new();
assert_eq!(p.port(), DEFAULT_PORT);

pub const fn with_port(port: u16) -> Self

Creates a new LiveReloadPlugin with a custom WebSocket port.

Examples

use ssg::livereload::LiveReloadPlugin;

let p = LiveReloadPlugin::with_port(8765);
assert_eq!(p.port(), 8765);

pub const fn port(&self) -> u16

Returns the configured port.

Examples

use ssg::livereload::LiveReloadPlugin;

let p = LiveReloadPlugin::with_port(8080);
assert_eq!(p.port(), 8080);

Trait Implementations

impl Clone for LiveReloadPlugin

fn clone(&self) -> LiveReloadPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LiveReloadPlugin

impl Debug for LiveReloadPlugin

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

Formats the value using the given formatter.

impl Default for LiveReloadPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for LiveReloadPlugin

fn name(&self) -> &'static str

Returns the unique name of this plugin.

fn on_serve(&self, ctx: &PluginContext) -> Result<(), SsgError>

Called before the development server starts serving files.

fn before_compile(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before site compilation begins.

fn after_compile(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called after site compilation completes.

fn transform_html( &self, html: &str, _path: &Path, _ctx: &PluginContext, ) -> Result<String, SsgError>

Per-file HTML transform hook — called once per HTML file during the fused transform pass.

fn has_transform(&self) -> bool

Returns true if this plugin implements transform_html. Override to true to opt in to the fused transform pass.

fn needs_all_files(&self) -> bool

Returns true if this plugin must always observe the full cache.html_files() list — even during --incremental rebuilds that only invalidated a handful of pages.