Struct PaginationPlugin 

pub struct PaginationPlugin { /* private fields */ }

Plugin that generates paginated listing pages.

Runs in after_compile. Reads .meta.json sidecars, collects pages with dates, sorts by date descending, and generates /page/N/index.html files.

Implementations

impl PaginationPlugin

pub fn with_per_page(per_page: usize) -> Self

Creates a pagination plugin with a custom page size.

Examples

use ssg::pagination::PaginationPlugin;
use ssg::plugin::Plugin;

let p = PaginationPlugin::with_per_page(25);
assert_eq!(p.name(), "pagination");

Trait Implementations

impl Clone for PaginationPlugin

fn clone(&self) -> PaginationPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PaginationPlugin

impl Debug for PaginationPlugin

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

Formats the value using the given formatter.

impl Default for PaginationPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PaginationPlugin

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

Returns the unique name of this plugin.

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 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.

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

Called before the development server starts serving files.