Struct Tree

pub struct Tree<'a> { /* private fields */ }

Represents a full flattened device tree blob (DTB).

Implementations

impl<'a> Tree<'a>

pub unsafe fn from_ptr<E: ParseError<&'a [u8]>>( ptr: *const u8, ) -> Result<Self, Err<E>>

Parse a devicetree blob that begins at the specified memory address.

Safety

The pointer must hold the address of the first byte of a valid devicetree blob, and it must uphold all the invariants of core::slice::from_raw_parts for a slice beginning at the specified address and extending the total length of the DTB as given in its header.

Errors

If the header does not have the correct magic number, or any other properties of the header are invalid, this function will return an error.

pub fn from_buffer<E: ParseError<&'a [u8]>>( data: &'a [u8], ) -> Result<Self, Err<E>>

Parse a devicetree blob that starts at the beginning of the slice and extends no further than its end.

Errors

If the header does not have the correct magic number, or any other properties of the header are invalid, this function will return an error.

pub fn memory_reservation_iter<E: ParseError<&'a [u8]> + 'a>( self: &'a Tree<'a>, ) -> impl Iterator<Item = Result<MemoryReservation, Err<E>>> + 'a

Iterate over memory reservations defined by this devicetree

pub fn structure_iter<E: GeneralParseError<&'a [u8]>>( self: &'a Tree<'a>, ) -> impl Iterator<Item = Result<StructureData<'a>, Err<E>>>

Iterate over elements in the device tree. Note that this does not directly iterate over nodes, but rather events that indicate the start of a node (including its children), a property defined on the node, or the end of a node.

Trait Implementations

impl<'a> Clone for Tree<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Tree<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Tree<'a>

fn default() -> Tree<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for Tree<'a>

fn eq(&self, other: &Tree<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for Tree<'a>

impl<'a> Eq for Tree<'a>

impl<'a> StructuralPartialEq for Tree<'a>