Struct ExtractionTemplate 

pub struct ExtractionTemplate {
    pub id: Uuid,
    pub name: String,
    pub description: Option<String>,
    pub regions: Vec<Region>,
    pub metadata: TemplateMetadata,
}

A reusable extraction template defining how to extract data from a page

Templates combine multiple regions, each with selectors and transformations. A template is the core unit of plugin configuration and is persisted for reuse.

Example

use stygian_plugin::domain::{ExtractionTemplate, Region, Selector};
use serde_json::json;

let template = ExtractionTemplate {
    id: uuid::Uuid::new_v4(),
    name: "Product Listing".to_string(),
    description: Some("Extract product cards from a listing page".to_string()),
    regions: vec![],
    metadata: Default::default(),
};

Fields

id: Uuid

Unique identifier for this template

name: String

User-friendly template name

description: Option<String>

Optional description

regions: Vec<Region>

Regions (named extraction zones) in this template

metadata: TemplateMetadata

Metadata (timestamps, version, etc.)

Implementations

impl ExtractionTemplate

pub fn new(name: impl Into<String>) -> Self

Create a new template with defaults

pub fn with_region(self, region: Region) -> Self

Add a region to this template

pub fn with_description(self, desc: impl Into<String>) -> Self

Set template description

pub fn with_tags(self, tags: Vec<String>) -> Self

Set template tags

pub fn validate(&self) -> Result<()>

Validate the entire template

Errors

Returns crate::error::PluginError::TemplateValidationError when the template name is empty. Propagates any error returned by the per-region validate() call (empty name, non-object schema, or invalid selector).

pub fn mark_used(&mut self)

Update usage statistics

Trait Implementations

impl Clone for ExtractionTemplate

fn clone(&self) -> ExtractionTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtractionTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExtractionTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExtractionTemplate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.