Struct syact::prelude::Factor

pub struct Factor(/* private fields */);

Represents a certain factor between 0 and 1

Unit

• Unitless

Implementations

impl Factor

pub const MAX: Factor = _

Maximum

pub const HALF: Factor = _

Half

pub const MIN: Factor = _

Minium

pub fn new(val: f32) -> Factor

Creates a new Factor

Panics

Panics if the given ‘val’ is out of bounds (0 <= val <= 1)

pub fn try_new(val: f32) -> Option<Factor>

Tries to create a new factor, will be None if val is not between or equal to 0 and 1

pub const unsafe fn new_unchecked(val: f32) -> Factor

Creates a new factor without checking bounds

Unsafe

An out of bounds factor might throw up important logic

Should only be used for creating literals

pub fn get_duty(self) -> u16

embedded_hal helper function

pub fn get_duty_for(self, max_duty: u16) -> u16

embedded_hal helper function

Trait Implementations

impl Clone for Factor

fn clone(&self) -> Factor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Factor

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

Formats the value using the given formatter.

impl Default for Factor

fn default() -> Factor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Factor

fn deserialize<__D>( __deserializer: __D ) -> Result<Factor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Factor

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

Formats the value using the given formatter.

impl Mul<Factor> for Velocity

type Output = Velocity

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> <Velocity as Mul<Factor>>::Output

Performs the * operation.

impl Mul for Factor

type Output = Factor

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> <Factor as Mul>::Output

Performs the * operation.

impl PartialEq for Factor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Factor

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Factor

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Factor

impl StructuralPartialEq for Factor