Struct AgentApiPlugin 

pub struct AgentApiPlugin { /* private fields */ }

Plugin that emits /api/agents/{index,posts,topics,person}.json.

Examples

use ssg::agent_api::AgentApiPlugin;
use ssg::plugin::Plugin;
assert_eq!(AgentApiPlugin::default().name(), "agent-api");

Implementations

impl AgentApiPlugin

pub fn new() -> Self

Creates the default (enabled) plugin.

Examples

use ssg::agent_api::AgentApiPlugin;
let _p = AgentApiPlugin::new();

pub const fn disabled() -> Self

Creates a disabled instance — the programmatic opt-out for pipelines that must not emit the API surface.

Examples

use ssg::agent_api::AgentApiPlugin;
let _p = AgentApiPlugin::disabled();

Trait Implementations

impl Clone for AgentApiPlugin

fn clone(&self) -> AgentApiPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AgentApiPlugin

impl Debug for AgentApiPlugin

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

Formats the value using the given formatter.

impl Default for AgentApiPlugin

fn default() -> Self

Default-on, per the #586 tracker.

impl Plugin for AgentApiPlugin

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.