Struct LocalizedSearchPlugin 

pub struct LocalizedSearchPlugin { /* private fields */ }

Variant of SearchPlugin that injects the widget with caller-supplied localized SearchLabels.

Example

use ssg::plugin::PluginManager;
use ssg::search::{LocalizedSearchPlugin, SearchLabels};

let mut pm = PluginManager::new();
pm.register(LocalizedSearchPlugin::new(SearchLabels::french()));

Implementations

impl LocalizedSearchPlugin

pub const fn new(labels: SearchLabels) -> Self

Create a new localized search plugin with the given labels.

Examples

use ssg::plugin::Plugin;
use ssg::search::{LocalizedSearchPlugin, SearchLabels};

let p = LocalizedSearchPlugin::new(SearchLabels::english());
assert_eq!(p.name(), "search");

Trait Implementations

impl Clone for LocalizedSearchPlugin

fn clone(&self) -> LocalizedSearchPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalizedSearchPlugin

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

Formats the value using the given formatter.

impl Plugin for LocalizedSearchPlugin

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.