Struct Signal

pub struct Signal<S>(/* private fields */);

See the signal pattern constructor.

Trait Implementations

impl<S: Clone> Clone for Signal<S>

fn clone(&self) -> Signal<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Signal<S>

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

Formats the value using the given formatter.

impl<S: Ord> Ord for Signal<S>

fn cmp(&self, other: &Signal<S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq for Signal<S>

fn eq(&self, other: &Signal<S>) -> 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<S: PartialOrd> PartialOrd for Signal<S>

fn partial_cmp(&self, other: &Signal<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Sample> Pattern for Signal<S>

type Value = <S as Sample>::Value

The type of the values emitted in the pattern’s events.

type Events = Once<Event<<Signal<S> as Pattern>::Value>>

An iterator yielding the events occuring within a query’s span.

fn query(&self, active: Span) -> Self::Events

Query the pattern for events within the given span.

fn query_cycle(&self) -> Self::Events

Query the pattern for events within a single cycle, (i.e. span!(0/1, 1/1)).

fn into_dyn(self) -> DynPattern<Self::Value>

where Self: 'static + Sized,

Convert the pattern to a trait object behind an Arc and dynamically box queries in order to represent the pattern with a known, sized type.

fn map<T, F>(self, map: F) -> MapValues<Self, F>

where Self: Sized, F: Fn(Self::Value) -> T,

Map the values produced by pattern queries with the given function.

fn map_query_points<F>(self, map: F) -> MapQueryPoints<Self, F>

where Self: Sized, F: Fn(Rational) -> Rational,

Map the start and end points of the pattern’s query spans.

fn map_event_points<F>(self, map: F) -> MapEventPoints<Self, F>

where Self: Sized, F: Fn(Rational) -> Rational,

Map the active and whole span start and end points of events produced by pattern queries with the given function. Useful for mapping time.

fn map_event_lens<F>(self, map: F) -> impl Pattern<Value = Self::Value>

where Self: Sized, F: Fn(Rational) -> Rational,

Map the length of the active and whole spans of all events produced by self.

fn map_events<F, T>(self, map: F) -> MapEvents<Self, F>

where Self: Sized, F: Fn(Event<Self::Value>) -> Event<T>,

Map the events produced by pattern queries with the given function.

fn map_events_iter<E, F, T>(self, map: F) -> MapEventsIter<Self, F>

where Self: Sized, F: Fn(Self::Events) -> E, E: Iterator<Item = Event<T>>,

Map the events iterator produced by the pattern queries with the given function.

fn rate(self, rate: Rational) -> Rate<Self>

where Self: Sized,

Increase or decrease the rate of event emission by the given value.

fn shift(self, amount: Rational) -> impl Pattern<Value = Self::Value>

where Self: 'static + Sized,

Shift the pattern by the given amount.

fn apply_with<P, F, B>(self, apply: P) -> impl Pattern<Value = B>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern<Value = F>, F: Fn(ApplyEvent<Self::Value>) -> (B, Option<Span>),

Apply the given pattern of functions to self.

fn apply<P, F, G, B>(self, apply: P, structure: G) -> impl Pattern<Value = B>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern<Value = F>, F: Fn(Self::Value) -> B, G: 'static + Fn(Span, Span) -> Span,

Apply the given pattern of functions to self.

fn app<P, F, B>(self, apply: P) -> impl Pattern<Value = B>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern<Value = F>, F: Fn(Self::Value) -> B,

Apply the given pattern of functions to self.

fn appl<P, F, B>(self, apply: P) -> impl Pattern<Value = B>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern<Value = F>, F: Fn(Self::Value) -> B,

Apply the given pattern of functions to self.

fn appr<P, F, B>(self, apply: P) -> impl Pattern<Value = B>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern<Value = F>, F: Fn(Self::Value) -> B,

Apply the given pattern of functions to self.

fn merge_with<P, F, T>(self, other: P, merge: F) -> impl Pattern<Value = T>

where Self: 'static + Sized, Self::Value: Clone, P: 'static + Pattern, P::Value: Clone, F: 'static + Fn(Self::Value, P::Value) -> T,

Merge the given pattern by calling the given function for each value at each active span intersection.

fn merge_extend<P>(self, other: P) -> impl Pattern<Value = Self::Value>

where Self: 'static + Sized, Self::Value: Clone + Extend<<P::Value as IntoIterator>::Item>, P: 'static + Pattern, P::Value: Clone + IntoIterator,

Merge the given pattern by calling Extend<P::Value> for each value at intersections of active spans.

fn polar(self) -> impl Pattern<Value = Self::Value>

where Self: Sized, Self::Value: Polar,

Assuming a pattern of values in the range 0 to 1, produces a pattern in the range -1 to 1.

fn phase(self) -> impl Pattern<Value = [Rational; 2]>

where Self: Sized,

Map a pattern’s active spans to start and end phases through their corresponding whole events.

fn debug_span(&self, span: Span) -> PatternDebug<'_, Self::Value, Self::Events>

where Self: Sized,

Return a wrapper providing a fmt::Debug implementation for the pattern.

fn debug(&self) -> PatternDebug<'_, Self::Value, Self::Events>

where Self: Sized,

Return a wrapper providing a fmt::Debug implementation for the pattern.

impl<S: Eq> Eq for Signal<S>

impl<S> StructuralPartialEq for Signal<S>