Struct FileMetadata

pub struct FileMetadata { /* private fields */ }

Implementations

impl FileMetadata

pub fn new() -> Ref<Self>

pub fn with_filename(name: &str) -> Ref<Self>

pub fn close(&self)

pub fn session_id(&self) -> usize

pub fn filename(&self) -> String

pub fn set_filename(&self, name: &str)

pub fn modified(&self) -> bool

pub fn mark_modified(&self)

pub fn mark_saved(&self)

pub fn is_analysis_changed(&self) -> bool

pub fn is_database_backed(&self) -> bool

pub fn is_database_backed_for_view_type(&self, view_type: &str) -> bool

pub fn run_undoable_transaction<F: FnOnce() -> Result<T, E>, T, E>( &self, func: F, ) -> Result<T, E>

Runs a failable function where the failure state will revert any undo actions that occurred during the time of the function’s execution.

NOTE: This will commit or undo any actions that occurred on any thread as this state is not thread local.

NOTE: This is NOT thread safe, if you are holding any locks that might be held by both the main thread and the thread executing this function, you can deadlock. You should also never call this function on multiple threads at a time. See the following issues:

• https://github.com/Vector35/binaryninja-api/issues/6289
• https://github.com/Vector35/binaryninja-api/issues/6325

pub fn begin_undo_actions(&self, anonymous_allowed: bool) -> String

Creates a new undo entry, any undo actions after this will be added to this entry.

NOTE: This is NOT thread safe, if you are holding any locks that might be held by both the main thread and the thread executing this function, you can deadlock. You should also never call this function on multiple threads at a time. See the following issues:

• https://github.com/Vector35/binaryninja-api/issues/6289
• https://github.com/Vector35/binaryninja-api/issues/6325

pub fn commit_undo_actions(&self, id: &str)

Commits the undo entry with the id to the undo buffer.

NOTE: This is NOT thread safe, if you are holding any locks that might be held by both the main thread and the thread executing this function, you can deadlock. You should also never call this function on multiple threads at a time. See the following issues:

• https://github.com/Vector35/binaryninja-api/issues/6289
• https://github.com/Vector35/binaryninja-api/issues/6325

pub fn revert_undo_actions(&self, id: &str)

Reverts the undo actions committed in the undo entry.

NOTE: This is NOT thread safe, if you are holding any locks that might be held by both the main thread and the thread executing this function, you can deadlock. You should also never call this function on multiple threads at a time. See the following issues:

• https://github.com/Vector35/binaryninja-api/issues/6289
• https://github.com/Vector35/binaryninja-api/issues/6325

pub fn forget_undo_actions(&self, id: &str)

Forgets the undo actions committed in the undo entry.

NOTE: This is NOT thread safe, if you are holding any locks that might be held by both the main thread and the thread executing this function, you can deadlock. You should also never call this function on multiple threads at a time. See the following issues:

• https://github.com/Vector35/binaryninja-api/issues/6289
• https://github.com/Vector35/binaryninja-api/issues/6325

pub fn undo(&self)

pub fn redo(&self)

pub fn current_view(&self) -> String

pub fn current_offset(&self) -> u64

pub fn navigate_to(&self, view: &str, offset: u64) -> Result<(), ()>

Navigate to an offset for a specific view.

Example

use binaryninja::file_metadata::FileMetadata;
file.navigate_to("Linear:Raw", 0x0).expect("Linear:Raw should always be present");

pub fn view_of_type(&self, view: &str) -> Option<Ref<BinaryView>>

Get the BinaryView for the view type.

Example

use binaryninja::file_metadata::FileMetadata;
file.view_of_type("Raw").expect("Raw type should always be present");

pub fn view_types(&self) -> Array<BnString>

pub fn project_file(&self) -> Option<Ref<ProjectFile>>

Get the ProjectFile for the FileMetadata.

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

pub fn create_database_with_progress<P: ProgressCallback>( &self, file_path: impl AsRef<Path>, progress: P, ) -> bool

pub fn save_auto_snapshot(&self) -> bool

pub fn open_database_for_configuration( &self, file: &Path, ) -> Result<Ref<BinaryView>, ()>

pub fn open_database(&self, file: &Path) -> Result<Ref<BinaryView>, ()>

pub fn open_database_with_progress<P: ProgressCallback>( &self, file: &Path, progress: P, ) -> Result<Ref<BinaryView>, ()>

pub fn database(&self) -> Option<Ref<Database>>

Get the current database

Trait Implementations

impl Debug for FileMetadata

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

Formats the value using the given formatter.

impl Hash for FileMetadata

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 FileMetadata

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

type Owned = Ref<FileMetadata>

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 FileMetadata

impl Send for FileMetadata

impl StructuralPartialEq for FileMetadata

impl Sync for FileMetadata