Struct DeployPlugin 

pub struct DeployPlugin { /* private fields */ }

Plugin that generates deployment configuration files.

Implementations

impl DeployPlugin

pub const fn new(target: DeployTarget) -> Self

Creates a new DeployPlugin for the given target.

Examples

use ssg::deploy::{DeployPlugin, DeployTarget};
use ssg::plugin::Plugin;

let p = DeployPlugin::new(DeployTarget::Netlify);
assert_eq!(p.name(), "deploy");

Trait Implementations

impl Clone for DeployPlugin

fn clone(&self) -> DeployPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DeployPlugin

impl Debug for DeployPlugin

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

Formats the value using the given formatter.

impl Plugin for DeployPlugin

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.