Skip to main content

Plugin

Trait Plugin 

Source
pub trait Plugin: Send + Sync {
    // Required method
    fn name(&self) -> &str;

    // Provided methods
    fn pre_process_feed<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _feed: &'life1 mut Feed,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn filter_item<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _item: &'life1 FeedItem,
    ) -> Pin<Box<dyn Future<Output = Result<FilterDecision>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn transform_item<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _item: &'life1 mut FeedItem,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn post_process_feed<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _feed: &'life1 mut Feed,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn on_fetch_error<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        _url: &'life1 str,
        _title: &'life2 str,
        _error: &'life3 Error,
    ) -> Pin<Box<dyn Future<Output = Option<Feed>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait { ... }
}

Required Methods§

Source

fn name(&self) -> &str

Human-readable plugin name

Provided Methods§

Source

fn pre_process_feed<'life0, 'life1, 'async_trait>( &'life0 self, _feed: &'life1 mut Feed, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Feed-level pre-processing (executed before item filtering)

Source

fn filter_item<'life0, 'life1, 'async_trait>( &'life0 self, _item: &'life1 FeedItem, ) -> Pin<Box<dyn Future<Output = Result<FilterDecision>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Evaluates whether an item should be kept or dropped

Source

fn transform_item<'life0, 'life1, 'async_trait>( &'life0 self, _item: &'life1 mut FeedItem, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Transforms/mutates an item in-place (e.g., cleans URLs, modifies title, alters content)

Source

fn post_process_feed<'life0, 'life1, 'async_trait>( &'life0 self, _feed: &'life1 mut Feed, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Feed-level post-processing (e.g. sorting, item count limiting)

Source

fn on_fetch_error<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _url: &'life1 str, _title: &'life2 str, _error: &'life3 Error, ) -> Pin<Box<dyn Future<Output = Option<Feed>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Invoked when upstream feed fails to fetch or parse. Returns an optional fallback Feed (e.g., NOP feed)

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§