Struct aml::AmlName

pub struct AmlName(_);

Methods

impl AmlName

pub fn root() -> AmlName

pub fn from_name_seg(seg: NameSeg) -> AmlName

pub fn from_str(string: &str) -> Option<AmlName>

Convert a string representation of an AML name into an AmlName. Returns None if the passed string is not a valid AML path.

pub fn as_string(&self) -> String

pub fn is_normal(&self) -> bool

An AML path is normal if it does not contain any prefix elements ("^" characters, when expressed as a string).

pub fn is_absolute(&self) -> bool

pub fn search_rules_apply(&self) -> bool

Special rules apply when searching for certain paths (specifically, those that are made up of a single name segment). Returns true if those rules apply.

pub fn normalize(self) -> Result<AmlName, AmlError>

Normalize an AML path, resolving prefix chars. Returns None if the path normalizes to an invalid path (e.g. \^_FOO)

pub fn parent(&self) -> Result<AmlName, AmlError>

Get the parent of this AmlName. For example, the parent of \_SB.PCI0._PRT is \_SB.PCI0. The root path has no parent, and so returns None.

pub fn resolve(&self, scope: &AmlName) -> Result<AmlName, AmlError>

Resolve this path against a given scope, making it absolute. If the path is absolute, it is returned directly. The path is also normalized.

Trait Implementations

impl Debug for AmlName

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

Formats the value using the given formatter.

impl Display for AmlName

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

Formats the value using the given formatter.

impl PartialEq<AmlName> for AmlName

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

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

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

This method tests for !=.

impl Eq for AmlName

impl Ord for AmlName

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<AmlName> for AmlName

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

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

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

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

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

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

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

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

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

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

impl Clone for AmlName

fn clone(&self) -> AmlName

Returns a copy of the value.

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

Performs copy-assignment from source.