Struct Position

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

A opaque fixed-point raw angular position reading from a sensor.

Implementations

impl Position

pub const fn from_ticks(ticks: i64, tpr: u32) -> Self

Creates a position from a custom tick reading with a given ticks-per-revolution value.

Essentially scales this value to the internal 36000 ticks per revolution.

pub const fn from_degrees(degrees: f64) -> Self

Creates a position from a specified number of degrees.

pub const fn from_radians(radians: f64) -> Self

Creates a position from a specified number of radians.

pub const fn from_revolutions(revolutions: f64) -> Self

Creates a position from a specified number of revolutions.

pub const fn as_degrees(&self) -> f64

Returns the number of degrees rotated in this position.

This function’s conversion from an internal representation may cause a loss of precision.

pub const fn as_radians(&self) -> f64

Returns the number of radians rotated in this position.

This function’s conversion from an internal representation may cause a loss of precision.

pub const fn as_revolutions(&self) -> f64

Returns the number of revolutions rotated in this position.

This function’s conversion from an internal representation may cause a loss of precision.

pub const fn as_ticks(&self, tpr: u32) -> i64

Returns this position’s value scaled to another tick value with a different TPR.

This function’s conversion from an internal representation may cause a loss of precision.

Trait Implementations

impl Add for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Position

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl Div<i64> for Position

type Output = Position

The resulting type after applying the / operator.

fn div(self, rhs: i64) -> Self::Output

Performs the / operation.

impl DivAssign<i64> for Position

fn div_assign(&mut self, rhs: i64)

Performs the /= operation.

impl Mul<i64> for Position

type Output = Position

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

impl MulAssign<i64> for Position

fn mul_assign(&mut self, rhs: i64)

Performs the *= operation.

impl Neg for Position

type Output = Position

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Position

fn cmp(&self, other: &Position) -> 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 PartialEq for Position

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd for Position

fn partial_cmp(&self, other: &Position) -> 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 Sub for Position

type Output = Position

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Position

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position