Struct SearchPlugin 

pub struct SearchPlugin;

Plugin that generates a search index and injects client-side search UI.

The unit form uses SearchLabels::english for the modal copy. To render the widget in another language, construct a LocalizedSearchPlugin.

Example

use ssg::plugin::PluginManager;
use ssg::search::SearchPlugin;

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

Trait Implementations

impl Clone for SearchPlugin

fn clone(&self) -> SearchPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SearchPlugin

impl Debug for SearchPlugin

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

Formats the value using the given formatter.

impl Plugin for SearchPlugin

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

Returns the unique name of this plugin.

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 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 after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Called after site compilation completes.

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

Called before site compilation begins.

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.

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

Called before the development server starts serving files.