Struct fdt_rs::DevTreeProp

pub struct DevTreeProp<'a> { /* fields omitted */ }

A handle to a DevTreeNode's Device Tree Property

Implementations

impl<'a> DevTreeProp<'a>

pub fn name(&self) -> Result<&'a Str, DevTreeError>

Returns the name of the property within the device tree.

#[must_use]pub fn parent(&self) -> DevTreeNode

Returns the node which this property is attached to

#[must_use]pub fn length(&self) -> usize

Returns the length of the property value within the device tree

pub unsafe fn get_u32(&self, offset: usize) -> Result<u32, DevTreeError>

Read a big-endian u32 from the provided offset in this device tree property's value. Convert the read value into the machines' native u32 format and return it.

If an offset which would cause this read to access memory outside of this property's value an Err containing DevTreeError::InvalidOffset will be returned.

Safety

Device Tree Properties are not strongly typed therefore any dereference could return unexpected data.

This method will access memory using core::ptr::read_unaligned, therefore an unaligned offset may be provided.

This method will not panic.

pub unsafe fn get_u64(&self, offset: usize) -> Result<u64, DevTreeError>

Read a big-endian u64 from the provided offset in this device tree property's value. Convert the read value into the machines' native u64 format and return it.

If an offset which would cause this read to access memory outside of this property's value an Err containing DevTreeError::InvalidOffset will be returned.

Safety

See the safety note of DevTreeProp::get_u32

pub unsafe fn get_phandle(&self, offset: usize) -> Result<Phandle, DevTreeError>

A Phandle is simply defined as a u32 value, as such this method performs the same action as [self.get_u32]

Safety

See the safety note of DevTreeProp::get_u32

pub unsafe fn get_str(&'a self, offset: usize) -> Result<&'a Str, DevTreeError>

Returns the string at the given offset if it can be parsed

Safety

See the safety note of DevTreeProp::get_u32

pub unsafe fn get_str_count(&self) -> Result<usize, DevTreeError>

Safety

See the safety note of DevTreeProp::get_u32

pub unsafe fn get_strlist(
    &'a self,
    list: &mut [Option<&'a Str>]
) -> Result<usize, DevTreeError>

Safety

See the safety note of DevTreeProp::get_u32

pub unsafe fn get_raw(&self) -> &'a [u8]

Safety

See the safety note of DevTreeProp::get_u32

Trait Implementations

impl<'a> Clone for DevTreeProp<'a>

fn clone(&self) -> DevTreeProp<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.