Processor

Enum Processor 

Source
pub enum Processor {
    Median(MedianProcessor),
    WeightedMedian(WeightedMedianProcessor),
}
Expand description

Represents different strategies for processing source data into a signal value.

The Processor enum encapsulates different algorithms for combining multiple input values from various sources into a single output value. Each variant contains its own configuration parameters.

§Variants

  • Median - Computes the median of the input values
  • WeightedMedian - Computes a weighted median based on configured weights

§Examples

Creating a median processor:

use bothan_lib::registry::processor::{Processor, median::MedianProcessor};
use serde_json::json;

// Create a processor from JSON
let json_data = json!({
    "function": "median",
    "params": {
        "min_source_count": 3
    }
});

let processor: Processor = serde_json::from_value(json_data).unwrap();
assert_eq!(processor.name(), "median");

Using a processor:

use bothan_lib::registry::processor::{Processor, median::MedianProcessor};
use rust_decimal::Decimal;

// Create a median processor that requires at least 3 sources
let processor = Processor::Median(MedianProcessor { min_source_count: 3 });

// Process some data
let data = vec![
    ("source1".to_string(), Decimal::new(100, 0)),
    ("source2".to_string(), Decimal::new(200, 0)),
    ("source3".to_string(), Decimal::new(300, 0)),
];

let result = processor.process(data).unwrap();
assert_eq!(result, Decimal::new(200, 0));

Variants§

§

Median(MedianProcessor)

Median processor that computes the median of input values.

§

WeightedMedian(WeightedMedianProcessor)

Weighted median processor that applies weights to input values.

Implementations§

Source§

impl Processor

Source

pub fn name(&self) -> &str

Returns the name of the processor.

This method returns a string identifier for the processor type, which can be used for logging, debugging, or serialization purposes.

Source

pub fn process( &self, data: Vec<(String, Decimal)>, ) -> Result<Decimal, ProcessError>

Processes input data into a single output value.

This method applies the processor’s algorithm to the input data to produce a single output value. The input data consists of pairs of source identifiers and their corresponding values.

§Errors

Returns a ProcessError if the processing operation fails, such as when:

  • There are insufficient data points
  • The data does not meet the processor’s requirements
  • A mathematical error occurs during processing

Trait Implementations§

Source§

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Processor

Source§

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.
Source§

impl Clone for Processor

Source§

fn clone(&self) -> Processor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Processor

Source§

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

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

impl<__Context> Decode<__Context> for Processor

Source§

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.
Source§

impl<'de> Deserialize<'de> for Processor

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 Encode for Processor

Source§

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl PartialEq for Processor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Processor

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
Source§

impl StructuralPartialEq for Processor

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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>,