Struct BinaryView 

pub struct BinaryView {
    pub handle: *mut BNBinaryView,
}

Represents the “whole view” of the binary and its analysis.

Analysis information:

• BinaryViewExt::functions
• BinaryViewExt::data_variables
• BinaryViewExt::strings

Annotation information:

• BinaryViewExt::symbols
• BinaryViewExt::tags_all_scopes
• BinaryViewExt::comments

Data representation and binary information:

• BinaryViewExt::types
• BinaryViewExt::segments
• BinaryViewExt::sections

Cleaning up

BinaryView has a cyclic relationship with the associated FileMetadata, each holds a strong reference to one another, so to properly clean up/free the BinaryView, you must manually close the file using FileMetadata::close, this is not fixable in the general case, until FileMetadata has only a weak reference to the BinaryView.

Fields

handle: *mut BNBinaryView

Implementations

impl BinaryView

pub unsafe fn from_raw(handle: *mut BNBinaryView) -> Self

pub fn from_metadata(meta: &FileMetadata) -> Result<Ref<Self>>

Construct the raw binary view from the given metadata.

Before calling this, make sure you have a valid file path set for the FileMetadata. It is required that the FileMetadata::file_path exist in the local filesystem.

pub fn from_path( meta: &FileMetadata, file_path: impl AsRef<Path>, ) -> Result<Ref<Self>>

Construct the raw binary view from the given file_path and metadata.

This will implicitly set the metadata file path and then construct the view. If the metadata already has the desired file path, use BinaryView::from_metadata instead.

pub unsafe fn from_accessor<A: Accessor>( meta: &FileMetadata, accessor: &mut FileAccessor<A>, ) -> Result<Ref<Self>>

Construct the raw binary view from the given accessor and metadata.

It is the responsibility of the caller to keep the accessor alive for the lifetime of the view; because of this, we mark the function as unsafe.

pub fn from_data(meta: &FileMetadata, data: &[u8]) -> Ref<Self>

Construct the raw binary view from the given data and metadata.

The data will be copied into the view, so the caller does not need to keep the data alive.

pub fn save_to_path(&self, file_path: impl AsRef<Path>) -> bool

Save the original binary file to the provided file_path along with any modifications.

WARNING: Currently there is a possibility to deadlock if the analysis has queued up a main thread action that tries to take the FileMetadata lock of the current view, and is executed while we are executing in this function.

To avoid the above issue use crate::main_thread::execute_on_main_thread_and_wait to verify there are no queued up main thread actions.

pub fn save_to_accessor<A: Accessor>(&self, file: &mut FileAccessor<A>) -> bool

Save the original binary file to the provided FileAccessor along with any modifications.

WARNING: Currently there is a possibility to deadlock if the analysis has queued up a main thread action that tries to take the FileMetadata lock of the current view, and is executed while we are executing in this function.

To avoid the above issue use crate::main_thread::execute_on_main_thread_and_wait to verify there are no queued up main thread actions.

Trait Implementations

impl AsRef<BinaryView> for BinaryView

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl BinaryViewBase for BinaryView

fn read(&self, buf: &mut [u8], offset: u64) -> usize

fn write(&self, offset: u64, data: &[u8]) -> usize

fn insert(&self, offset: u64, data: &[u8]) -> usize

fn remove(&self, offset: u64, len: usize) -> usize

fn offset_valid(&self, offset: u64) -> bool

Check if the offset is valid for the current view.

fn offset_readable(&self, offset: u64) -> bool

Check if the offset is readable for the current view.

fn offset_writable(&self, offset: u64) -> bool

Check if the offset is writable for the current view.

fn offset_executable(&self, offset: u64) -> bool

Check if the offset is executable for the current view.

fn offset_backed_by_file(&self, offset: u64) -> bool

Check if the offset is backed by the original file and not added after the fact.

fn next_valid_offset_after(&self, offset: u64) -> u64

Get the next valid offset after the provided offset, useful if you need to iterate over all readable offsets in the view.

fn modification_status(&self, offset: u64) -> ModificationStatus

Whether the data at the given offset been modified (patched).

fn start(&self) -> u64

The lowest address in the view.

fn len(&self) -> u64

The length of the view.

fn executable(&self) -> bool

fn relocatable(&self) -> bool

fn entry_point(&self) -> u64

fn default_endianness(&self) -> Endianness

fn address_size(&self) -> usize

fn save(&self) -> bool

impl Debug for BinaryView

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

Formats the value using the given formatter.

impl Hash for BinaryView

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 BinaryView

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

type Owned = Ref<BinaryView>

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 BinaryView

impl Send for BinaryView

impl StructuralPartialEq for BinaryView

impl Sync for BinaryView