Struct ChannelFilter 

pub struct ChannelFilter { /* private fields */ }

Wraps another dispatcher and forwards a subset of channels by name.

Channel names are validated during init against the controller’s dispatcher channel list. Missing or duplicate names are treated as errors. The output order follows the order provided in channels.

Note: timestamps are forwarded unchanged; only the per-channel values are filtered.

Implementations

impl ChannelFilter

pub fn new(inner: Box<dyn Dispatcher>, channels: Vec<String>) -> Box<Self>

Create a channel filter around another dispatcher.

The filter order follows channels, and names must be unique and present in the controller’s channel list at init time.

Trait Implementations

impl<'de> Deserialize<'de> for ChannelFilter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Dispatcher for ChannelFilter

fn init( &mut self, ctx: &ControllerCtx, channel_names: &[String], core_assignment: usize, ) -> Result<(), String>

Set up the dispatcher at the start of a run

fn consume( &mut self, time: SystemTime, timestamp: i64, channel_values: Vec<f64>, ) -> Result<(), String>

Ingest a row of data

fn terminate(&mut self) -> Result<(), String>

Shut down the dispatcher and reset internal state for the next run

impl<'py> IntoPyObject<'py> for ChannelFilter

type Target = ChannelFilter

The Python output type

type Output = Bound<'py, <ChannelFilter as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for ChannelFilter

const NAME: &str = "ChannelFilter"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ChannelFilter

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Wraps another dispatcher and forwards a subset of channels by name. /// /// Channel names are validated during `init` against the controller's /// dispatcher channel list. Missing or duplicate names are treated as errors. /// The output order follows the order provided in `channels`. /// /// Note: timestamps are forwarded unchanged; only the per-channel values are filtered.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<ChannelFilter as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<ChannelFilter>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for ChannelFilter

const TEXT_SIGNATURE: &'static str = "(inner, channels)"

impl PyMethods<ChannelFilter> for PyClassImplCollector<ChannelFilter>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for ChannelFilter

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for ChannelFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for ChannelFilter

impl ExtractPyClassWithClone for ChannelFilter