Skip to main content

ExtractionTemplate

Struct ExtractionTemplate 

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

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§

Source§

impl ExtractionTemplate

Source

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

Create a new template with defaults

Source

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

Add a region to this template

Source

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

Set template description

Source

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

Set template tags

Source

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

Validate the entire template

Source

pub fn mark_used(&mut self)

Update usage statistics

Trait Implementations§

Source§

impl Clone for ExtractionTemplate

Source§

fn clone(&self) -> ExtractionTemplate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExtractionTemplate

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ExtractionTemplate

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,