Struct PulseDuration 

pub struct PulseDuration {
    keep_negative: bool,
    polarity: PulsePolarity,
    last: Option<(DateTime<Utc>, bool)>,
}

Mutable step that outputs the duration of a pulse.

This step operates on boolean values and will explicitly cast non-boolean values to boolean using whalesong::Value::cast_boolean_value.

A pulse is a contiguous period of time where the boolean value remains the same. You can explicitly select whether you only want to consider the “high”, “low”, or both pulses.

To better illustrate the concept of a pulse, here’s an illustration:

 true    /---------\         /---------\
         |         |         |         |
false  __/         \_________/         |
         ^         ^         ^         ^
         t0        t1        t2        t3

There are three pulses in the above example:

1. t0 to t1 (High)
2. t1 to t2 (Low)
3. t2 to t3 (High)

Fields

keep_negative: bool

polarity: PulsePolarity

last: Option<(DateTime<Utc>, bool)>

Implementations

impl PulseDuration

pub const fn new() -> Self

Creates a new instance.

pub const fn with_keep_negative(self, keep_negative: bool) -> Self

Configures whether to emit negative durations.

By default, negative durations are dropped.

pub const fn with_polarity(self, polarity: PulsePolarity) -> Self

Configures the pulse polarity.

By default, only “high” pulses are considered.

Trait Implementations

impl Clone for PulseDuration

fn clone(&self) -> PulseDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PulseDuration

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

Formats the value using the given formatter.

impl Default for PulseDuration

fn default() -> Self

Returns the “default value” for a type.

impl From<PulseDuration> for AnyStepMut

fn from(step: PulseDuration) -> Self

Converts to this type from the input type.

impl StepMut for PulseDuration

fn is_redundant(&self) -> bool

Returns true if the step is redundant.

fn transform( &mut self, timestamp: DateTime<Utc>, _attributes: &Attributes, value: &mut Value, ) -> Outcome

Transforms a value.