Struct Silencer

pub struct Silencer<T: SilencerConfig> { /* private fields */ }

Datagram to configure the silencer.

Implementations

impl<T: SilencerConfig> Silencer<T>

pub const fn config(&self) -> T

Configuration of the silencer.

pub const fn target(&self) -> SilencerTarget

The target of the silencer.

impl<T: SilencerConfig> Silencer<T>

pub const fn with_target(self, target: SilencerTarget) -> Self

Set the target field.

impl Silencer<()>

pub const DEFAULT_COMPLETION_TIME_INTENSITY: Duration

The default completion time of the intensity change.

pub const DEFAULT_COMPLETION_TIME_PHASE: Duration

The default completion time of the phase change.

pub const fn new<T: SilencerConfig>(config: T) -> Silencer<T>

Creates a Silencer.

pub const fn disable() -> Silencer<FixedCompletionTime>

Creates a Silencer to disable the silencer.

impl Silencer<FixedCompletionTime>

pub const fn strict_mode(&self) -> bool

Whether the strict mode is enabled. The default is true.

If the strict mode is enabled, an error is returned if the phase/intensity change of Modulation, FociSTM or GainSTM cannot be completed within the time specified by the silencer.

pub const fn with_strict_mode(self, strict_mode: bool) -> Self

Sets the strict_mode.

pub fn is_valid<T: HasSamplingConfig>(&self, target: &T) -> bool

Validate whether it is safe to use this Silencer with target.

Trait Implementations

impl<T: Clone + SilencerConfig> Clone for Silencer<T>

fn clone(&self) -> Silencer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: SilencerConfig> Datagram for Silencer<T>

where SilencerOpGenerator<T>: OperationGenerator,

fn timeout(&self) -> Option<Duration>

Returns the timeout duration.

fn parallel_threshold(&self) -> Option<usize>

Returns the parallel threshold.

impl<T: Debug + SilencerConfig> Debug for Silencer<T>

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

Formats the value using the given formatter.

impl Default for Silencer<FixedCompletionTime>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + SilencerConfig> Copy for Silencer<T>