Struct ScaleLockPlayer 

pub struct ScaleLockPlayer {
    pub scale: PlayerScale,
    pub policy: ScaleLockPolicy,
}

Applies a ScaleLockPolicy to incoming pitches against a PlayerScale.

Fields

scale: PlayerScale

The scale to lock pitches onto.

policy: ScaleLockPolicy

The policy used to handle out-of-scale pitches.

Implementations

impl ScaleLockPlayer

pub fn new(scale: PlayerScale, policy: ScaleLockPolicy) -> Self

Constructs a scale-lock player from a PlayerScale and a policy.

pub fn from_scale(scale: Scale, policy: ScaleLockPolicy) -> Self

Constructs a scale-lock player directly from a Scale and a policy.

pub fn process_pitch(&self, pitch: Pitch) -> Option<Pitch>

Applies the policy to a single pitch, returning None when a ScaleLockPolicy::Filter policy rejects it.

pub fn process_pitches( &self, pitches: impl IntoIterator<Item = Pitch>, ) -> Vec<Pitch>

Applies the policy to a sequence of pitches, collecting the surviving results.

Trait Implementations

impl Clone for ScaleLockPlayer

fn clone(&self) -> ScaleLockPlayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScaleLockPlayer

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

Formats the value using the given formatter.

impl Eq for ScaleLockPlayer

impl Hash for ScaleLockPlayer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScaleLockPlayer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScaleLockPlayer