pub enum AmlValue {
Show 14 variants
Boolean(bool),
Integer(u64),
String(String),
OpRegion {
region: RegionSpace,
offset: u64,
length: u64,
parent_device: Option<AmlName>,
},
Field {
region: AmlHandle,
flags: FieldFlags,
offset: u64,
length: u64,
},
Device,
Method {
flags: MethodFlags,
code: MethodCode,
},
Buffer(Arc<Spinlock<Vec<u8>>>),
BufferField {
buffer_data: Arc<Spinlock<Vec<u8>>>,
offset: u64,
length: u64,
},
Processor {
id: u8,
pblk_address: u32,
pblk_len: u8,
},
Mutex {
sync_level: u8,
},
Package(Vec<AmlValue>),
PowerResource {
system_level: u8,
resource_order: u16,
},
ThermalZone,
}
Variants§
Boolean(bool)
Integer(u64)
String(String)
OpRegion
Describes an operation region. Some regions require other objects to be declared under their parent device
(e.g. an _ADR
object for a PciConfig
region), in which case an absolute path to the object is stored in
parent_device
.
Field
Describes a field unit within an operation region.
Device
Method
Buffer(Arc<Spinlock<Vec<u8>>>)
BufferField
Processor
Mutex
Package(Vec<AmlValue>)
PowerResource
ThermalZone
Implementations§
source§impl AmlValue
impl AmlValue
pub fn zero() -> AmlValue
pub fn one() -> AmlValue
pub fn ones() -> AmlValue
pub fn native_method<F>( arg_count: u8, serialize: bool, sync_level: u8, f: F ) -> AmlValuewhere F: Fn(&mut AmlContext) -> Result<AmlValue, AmlError> + 'static + Send + Sync,
pub fn type_of(&self) -> AmlType
pub fn as_bool(&self) -> Result<bool, AmlError>
pub fn as_integer(&self, context: &AmlContext) -> Result<u64, AmlError>
pub fn as_buffer( &self, context: &AmlContext ) -> Result<Arc<Spinlock<Vec<u8>>>, AmlError>
pub fn as_string(&self, context: &AmlContext) -> Result<String, AmlError>
sourcepub fn as_concat_type(&self) -> AmlValue
pub fn as_concat_type(&self) -> AmlValue
Converts an AmlValue
to the representation that should be used when concatenating it with other values,
primarily by the DefConcat
opcode. This will always produce a AmlValue::Integer
, AmlValue::String
, or
AmlValue::Buffer
, with other types being converted to strings containing the name of their type.
sourcepub fn as_status(&self) -> Result<StatusObject, AmlError>
pub fn as_status(&self) -> Result<StatusObject, AmlError>
Turns an AmlValue
returned from a _STA
method into a StatusObject
. Should only be called for values
returned from _STA
. If you need a StatusObject
, but the device does not have a _STA
method, use
StatusObject::default()
.
sourcepub fn as_type(
&self,
desired_type: AmlType,
context: &AmlContext
) -> Result<AmlValue, AmlError>
pub fn as_type( &self, desired_type: AmlType, context: &AmlContext ) -> Result<AmlValue, AmlError>
Convert this value to a value of the same data, but with the given AML type, if possible, by converting the implicit conversions described in §19.3.5 of the spec.
The implicit conversions applied are:
Buffer
from: Integer
, String
, Debug
BufferField
from: Integer
, Buffer
, String
, Debug
DdbHandle
from: Integer
, Debug
FieldUnit
from: Integer
,Buffer
, String
, Debug
Integer
from: Buffer
, BufferField
, DdbHandle
, FieldUnit
, String
, Debug
Package
from: Debug
String
from: Integer
, Buffer
, Debug
sourcepub fn read_field(&self, context: &AmlContext) -> Result<AmlValue, AmlError>
pub fn read_field(&self, context: &AmlContext) -> Result<AmlValue, AmlError>
Reads from a field of an opregion, returning either a AmlValue::Integer
or an AmlValue::Buffer
,
depending on the size of the field.
pub fn write_field( &mut self, value: AmlValue, context: &mut AmlContext ) -> Result<(), AmlError>
pub fn read_buffer_field( &self, context: &AmlContext ) -> Result<AmlValue, AmlError>
pub fn write_buffer_field( &mut self, value: AmlValue, context: &mut AmlContext ) -> Result<(), AmlError>
sourcepub fn cmp(
&self,
other: AmlValue,
context: &mut AmlContext
) -> Result<Ordering, AmlError>
pub fn cmp( &self, other: AmlValue, context: &mut AmlContext ) -> Result<Ordering, AmlError>
Logically compare two AmlValue
s, according to the rules that govern opcodes like DefLEqual
, DefLLess
,
etc. The type of self
dictates the type that other
will be converted to, and the method by which the
values will be compared:
Integer
s are simply compared by numeric comparisonString
s andBuffer
s are compared lexicographically -other
is compared byte-wise until a byte is discovered that is either less or greater than the corresponding byte ofself
. If the bytes are identical, the lengths are compared. Luckily, the Rust standard library implements lexicographic comparison of strings and[u8]
for us already.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for AmlValue
impl Send for AmlValue
impl Sync for AmlValue
impl Unpin for AmlValue
impl !UnwindSafe for AmlValue
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.