Struct Structure

pub struct Structure { /* private fields */ }

Implementations

impl Structure

pub fn builder() -> StructureBuilder

pub fn width(&self) -> u64

pub fn structure_type(&self) -> StructureType

pub fn members_at_offset( &self, container: &TypeContainer, offset: u64, ) -> Vec<StructureMember>

Retrieve the members that are accessible at a given offset.

The reason for this being plural is that members may overlap and the offset is in bytes where a bitfield may contain multiple members at the given byte.

Unions are also represented as structures and will cause this function to return all members that can reach that offset.

We must pass a TypeContainer here so that we can resolve base structure members, as they are treated as members through this function. Typically, you get the TypeContainer through the binary view with BinaryViewExt::type_container.

pub fn members(&self) -> Vec<StructureMember>

Return the list of non-inherited structure members.

If you want to get all members, including ones inherited from base structures, use Structure::members_including_inherited instead.

pub fn members_including_inherited( &self, container: &TypeContainer, ) -> Vec<InheritedStructureMember>

Returns the list of all structure members, including inherited ones.

Because we must traverse through base structures, we have to provide the TypeContainer; in most cases it is ok to provide the binary views container via BinaryViewExt::type_container.

pub fn base_structures(&self) -> Vec<BaseStructure>

Retrieve the list of base structures for the structure. These base structures are what give a structure inherited members.

pub fn is_packed(&self) -> bool

Whether the structure is packed or not.

pub fn alignment(&self) -> usize

Trait Implementations

impl Debug for Structure

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

Formats the value using the given formatter.

impl From<&Structure> for StructureBuilder

fn from(structure: &Structure) -> StructureBuilder

Converts to this type from the input type.

impl Hash for Structure

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Structure

fn eq(&self, other: &Structure) -> 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 ToOwned for Structure

type Owned = Ref<Structure>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for Structure

impl StructuralPartialEq for Structure