Struct Periodic 

pub struct Periodic<'a> { /* private fields */ }

A periodic waveform effect.

The 'a lifetime is only relevant when the effect uses a custom waveform. It indicates the lifetime of that custom waveform data (which the Periodic struct borrows from). For all other types of Periodic events, the lifetime can be 'static.

Implementations

impl<'a> Periodic<'a>

pub fn simple(waveform: Waveform, period: u16, magnitude: i16) -> Periodic<'a>

Creates a simple Periodic effect with a fixed Waveform.

pub fn custom(data: &'a [i16]) -> Periodic<'a>

Creates a custom waveform effect.

The device has to advertise support for Feature::CUSTOM for this to work.

Panics

Panics when data is longer than u32::MAX elements. In practice, no device will accept a waveform that large anyways.

pub fn with_envelope(self, env: Envelope) -> Self

pub fn with_offset(self, offset: i16) -> Self

pub fn with_phase(self, phase: u16) -> Self

pub fn waveform(&self) -> Waveform

Returns the type of Waveform described by this Periodic effect.

pub fn period(&self) -> u16

Waveform period in ms.

pub fn magnitude(&self) -> i16

pub fn offset(&self) -> i16

Vertical offset of the waveform (and its approximate mean value).

pub fn phase(&self) -> u16

The horizontal phase offset in the effect’s Waveform where playback will begin.

pub fn envelope(&self) -> Envelope

pub fn custom_data(&self) -> Option<&'a [i16]>

If this effect has type Waveform::CUSTOM, returns a reference to the custom waveform data.

Also see Periodic::custom for how to create such an effect.

Trait Implementations

impl<'a> Clone for Periodic<'a>

fn clone(&self) -> Periodic<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Periodic<'_>

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

Formats the value using the given formatter.

impl<'a> From<Periodic<'a>> for Effect<'a>

fn from(value: Periodic<'a>) -> Self

Converts to this type from the input type.

impl PartialEq for Periodic<'_>

fn eq(&self, other: &Self) -> 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<'a> Copy for Periodic<'a>

impl Eq for Periodic<'_>