Struct FilterRegistration 

pub struct FilterRegistration { /* private fields */ }

Safe filter declaration used by Rust plugins.

Implementations

impl FilterRegistration

pub const fn new( name: &'static str, publisher: &'static str, plugin: &'static str, ) -> FilterRegistration

Creates filter registration fields.

pub const fn name(&self) -> &'static str

Returns filter name.

pub const fn publisher(&self) -> &'static str

Returns publisher namespace.

pub const fn plugin(&self) -> &'static str

Returns plugin namespace.

pub const fn with_visibility( self, visibility: FilterVisibility, ) -> FilterRegistration

Returns registration with explicit script visibility.

pub const fn private(self) -> FilterRegistration

Returns registration hidden from public script lookup.

pub const fn with_planner( self, planner: fn(PlanRequest<'_>) -> Result<FilterPlan, PixelFlowError>, ) -> FilterRegistration

Returns registration with planner callback attached.

pub const fn with_expander( self, expander: fn(ExpansionRequest<'_>) -> Result<Clip, PixelFlowError>, ) -> FilterRegistration

Returns registration with expander callback attached.

pub const fn with_executor( self, executor: fn(ExecutorRequest<'_>) -> Result<Box<dyn FrameExecutor>, PixelFlowError>, ) -> FilterRegistration

Returns registration with executor factory callback attached.

pub const fn planner( &self, ) -> Option<fn(PlanRequest<'_>) -> Result<FilterPlan, PixelFlowError>>

Returns planner callback when registered.

pub const fn expander( &self, ) -> Option<fn(ExpansionRequest<'_>) -> Result<Clip, PixelFlowError>>

Returns expander callback when registered.

pub const fn executor( &self, ) -> Option<fn(ExecutorRequest<'_>) -> Result<Box<dyn FrameExecutor>, PixelFlowError>>

Returns executor factory callback when registered.

pub const fn visibility(&self) -> FilterVisibility

Returns script visibility for this registration.

pub const fn has_planner(&self) -> bool

Returns true when registration has planner callback.

pub const fn has_expander(&self) -> bool

Returns true when registration has expander callback.

pub const fn has_executor(&self) -> bool

Returns true when registration has executor factory callback.

Trait Implementations

impl Clone for FilterRegistration

fn clone(&self) -> FilterRegistration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterRegistration

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

Formats the value using the given formatter.

impl PartialEq for FilterRegistration

fn eq(&self, other: &FilterRegistration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilterRegistration