Struct aml::AmlHandle

pub struct AmlHandle(_);

A handle is used to refer to an AML value without actually borrowing it until you need to access it (this makes borrowing situation much easier as you only have to consider who’s borrowing the namespace). They can also be cached to avoid expensive namespace lookups.

Handles are never reused (the handle to a removed object will never be reused to point to a new object). This ensures handles cached by the library consumer will never point to an object they did not originally point to, but also means that, in theory, we can run out of handles on a very-long-running system (we are yet to see if this is a problem, practically).

Trait Implementations

impl Clone for AmlHandle

fn clone(&self) -> AmlHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AmlHandle

impl Debug for AmlHandle

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

Formats the value using the given formatter.

impl Eq for AmlHandle

impl Ord for AmlHandle

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<AmlHandle> for AmlHandle

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

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

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

This method tests for !=.

impl PartialOrd<AmlHandle> for AmlHandle

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for AmlHandle

impl StructuralPartialEq for AmlHandle