Struct libmedium::units::Current

pub struct Current(_);

Struct that represents an electrical current.

Implementations

impl Current

pub fn from_milli_amperes(millis: i32) -> Current

Create a Current struct from a value measuring milliamperes.

pub fn as_milli_amperes(self) -> i32

Return this Current's value in milliamperes.

pub fn from_amperes(joules: impl Into<f64>) -> Current

Create a Current struct from a value measuring amperes.

pub fn as_amperes(self) -> f64

Return this Current's value in amperes.

Trait Implementations

impl Add<Current> for Current

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<S: CurrSensor> Average<Current> for S

fn read_average(&self) -> Result<P, Error>

Reads this sensor's average value. Returns an error, if this sensor doesn't support the feature.

impl Clone for Current

fn clone(&self) -> Current

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Current

impl<S: CurrSensor> Crit<Current> for S

fn read_crit(&self) -> Result<P, Error>

Reads this sensor's crit value. Returns an error, if this sensor doesn't support the feature.

fn write_crit(&self, crit: P) -> Result<(), Error> where
    Self: WritableSensorBase, 

Writes this sensor's crit value. Returns an error, if this sensor doesn't support the feature.

impl Debug for Current

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

Formats the value using the given formatter.

impl Display for Current

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

Formats the value using the given formatter.

impl<T: Into<i32>> Div<T> for Current

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: T) -> Current

Performs the / operation.

impl Eq for Current

impl Hash for Current

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, 

Feeds a slice of this type into the given Hasher.

impl<S: CurrSensor> Highest<Current> for S

fn read_highest(&self) -> Result<P, Error>

Reads this sensor's historically highest input. Returns an error, if this sensor doesn't support the feature.

impl<S: CurrSensor> LowCrit<Current> for S

fn read_lcrit(&self) -> Result<P, Error>

Reads this sensor's lcrit value. Returns an error, if this sensor doesn't support the feature.

fn write_lcrit(&self, lcrit: P) -> Result<(), Error> where
    Self: WritableSensorBase, 

Writes this sensor's lcrit value. Returns an error, if this sensor doesn't support the feature.

impl<S: CurrSensor> Lowest<Current> for S

fn read_lowest(&self) -> Result<P, Error>

Reads this sensor's historically lowest input. Returns an error, if this sensor doesn't support the feature.

impl<S: CurrSensor> Max<Current> for S

fn read_max(&self) -> Result<P, Error>

Reads this sensor's max value. Returns an error, if this sensor doesn't support the feature.

fn write_max(&self, max: P) -> Result<(), Error> where
    Self: WritableSensorBase, 

Writes this sensor's max value. Returns an error, if this sensor doesn't support the feature.

impl<S: CurrSensor> Min<Current> for S

fn read_min(&self) -> Result<P, Error>

Reads this sensor's min value. Returns an error, if this sensor doesn't support the feature.

fn write_min(&self, min: P) -> Result<(), Error> where
    Self: WritableSensorBase, 

Writes this sensor's min value. Returns an error, if this sensor doesn't support the feature.

impl<T: Into<i32>> Mul<T> for Current

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: T) -> Current

Performs the * operation.

impl Ord for Current

fn cmp(&self, other: &Current) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Current> for Current

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

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

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

This method tests for !=.

impl PartialOrd<Current> for Current

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

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

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

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

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

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

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

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

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

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

impl Raw for Current

fn from_raw(raw: &str) -> Result<Self, Error>

Converts a raw sensor string into a usable type.

fn to_raw(&self) -> Cow<'_, str>

Converts self into a writable raw sensor string.

impl<S: CurrSensor> Sensor<Current> for S

fn read_input(&self) -> Result<P, Error>

Reads the input subfunction of this sensor. Returns an error, if this sensor doesn't support the subtype.

fn read_enable(&self) -> Result<bool, Error>

Reads whether or not this sensor is enabled. Returns an error, if this sensor doesn't support the feature.

fn write_enable(&self, enable: bool) -> Result<(), Error> where
    Self: WritableSensorBase, 

Enables or disables this sensor. Returns an error if this functionality is not supported by the sensor.

impl StructuralEq for Current

impl StructuralPartialEq for Current