Struct binaryninja::project::Project

source ·

#[repr(C)]
pub struct Project { /* private fields */ }

Implementations§

source §

impl Project

source

pub fn all_open() -> Array<Project>

source

pub fn create<P: BnStrCompatible, S: BnStrCompatible>(path: P, name: S) -> Self

Create a new project

path - Path to the project directory (.bnpr)
name - Name of the new project

source

pub fn open_project<P: BnStrCompatible>(path: P) -> Self

Open an existing project

path - Path to the project directory (.bnpr) or project metadata file (.bnpm)

source

pub fn is_open(&self) -> bool

Check if the project is currently open

source

pub fn open(&self) -> Result<(), ()>

Open a closed project

source

pub fn close(&self) -> Result<(), ()>

Close a open project

source

pub fn id(&self) -> BnString

Get the unique id of this project

source

pub fn path(&self) -> BnString

Get the path of the project

source

pub fn name(&self) -> BnString

Get the name of the project

source

pub fn set_name<S: BnStrCompatible>(&self, value: S)

Set the name of the project

source

pub fn description(&self) -> BnString

Get the description of the project

source

pub fn set_description<S: BnStrCompatible>(&self, value: S)

Set the description of the project

source

pub fn query_metadata<S: BnStrCompatible>(&self, key: S) -> Ref<Metadata>

Retrieves metadata stored under a key from the project

source

pub fn store_metadata<S: BnStrCompatible>( &self, key: S, value: &Metadata ) -> bool

Stores metadata within the project,

key - Key under which to store the Metadata object
value - Object to store

source

pub fn remove_metadata<S: BnStrCompatible>(&self, key: S)

Removes the metadata associated with this key from the project

source

pub fn push_folder(&self, file: &ProjectFolder)

source

pub fn create_folder_from_path<P, D>( &self, path: P, parent: Option<&ProjectFolder>, description: D ) -> Result<ProjectFolder, ()>
where P: BnStrCompatible, D: BnStrCompatible,

Recursively create files and folders in the project from a path on disk

path - Path to folder on disk
parent - Parent folder in the project that will contain the new contents
description - Description for created root folder

source

pub fn create_folder_from_path_with_progress<P, D, F>( &self, path: P, parent: Option<&ProjectFolder>, description: D, progress_func: F ) -> Result<ProjectFolder, ()>
where P: BnStrCompatible, D: BnStrCompatible, F: FnMut(usize, usize) -> bool,

Recursively create files and folders in the project from a path on disk

path - Path to folder on disk
parent - Parent folder in the project that will contain the new contents
description - Description for created root folder
progress_func - Progress function that will be called

source

pub fn create_folder<N, D>( &self, parent: Option<&ProjectFolder>, name: N, description: D ) -> Result<ProjectFolder, ()>
where N: BnStrCompatible, D: BnStrCompatible,

Recursively create files and folders in the project from a path on disk

parent - Parent folder in the project that will contain the new folder
name - Name for the created folder
description - Description for created folder

source

pub unsafe fn create_folder_unsafe<N, D, I>( &self, parent: Option<&ProjectFolder>, name: N, description: D, id: I ) -> Result<ProjectFolder, ()>
where N: BnStrCompatible, D: BnStrCompatible, I: BnStrCompatible,

Recursively create files and folders in the project from a path on disk

parent - Parent folder in the project that will contain the new folder
name - Name for the created folder
description - Description for created folder
id - id unique ID

source

pub fn folders(&self) -> Result<Array<ProjectFolder>, ()>

Get a list of folders in the project

source

pub fn folder_by_id<S: BnStrCompatible>(&self, id: S) -> Option<ProjectFolder>

Retrieve a folder in the project by unique folder id

source

pub fn delete_folder(&self, folder: &ProjectFolder) -> Result<(), ()>

Recursively delete a folder from the project

folder - Folder to delete recursively

source

pub fn delete_folder_with_progress<F>( &self, folder: &ProjectFolder, progress_func: F ) -> Result<(), ()>
where F: FnMut(usize, usize) -> bool,

Recursively delete a folder from the project

folder - Folder to delete recursively
progress_func - Progress function that will be called as objects get deleted

source

pub fn push_file(&self, file: &ProjectFile)

source

pub fn create_file_from_path<P, N, D>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D ) -> Result<ProjectFile, ()>
where P: BnStrCompatible, N: BnStrCompatible, D: BnStrCompatible,

Create a file in the project from a path on disk

path - Path on disk
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file

source

pub fn create_file_from_path_with_progress<P, N, D, F>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, progress_func: F ) -> Result<ProjectFile, ()>
where P: BnStrCompatible, N: BnStrCompatible, D: BnStrCompatible, F: FnMut(usize, usize) -> bool,

Create a file in the project from a path on disk

path - Path on disk
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
progress_func - Progress function that will be called as the file is being added

source

pub unsafe fn create_file_from_path_unsafe<P, N, D, I>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime ) -> Result<ProjectFile, ()>
where P: BnStrCompatible, N: BnStrCompatible, D: BnStrCompatible, I: BnStrCompatible,

Create a file in the project from a path on disk

path - Path on disk
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
id - id unique ID
creation_time - Creation time of the file

source

pub unsafe fn create_file_from_path_with_progress_unsafe<P, N, D, I, F>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime, progress_func: F ) -> Result<ProjectFile, ()>
where P: BnStrCompatible, N: BnStrCompatible, D: BnStrCompatible, I: BnStrCompatible, F: FnMut(usize, usize) -> bool,

Create a file in the project from a path on disk

path - Path on disk
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
id - id unique ID
creation_time - Creation time of the file
progress_func - Progress function that will be called as the file is being added

source

pub fn create_file<N, D>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D ) -> Result<ProjectFile, ()>
where N: BnStrCompatible, D: BnStrCompatible,

Create a file in the project

contents - Bytes of the file that will be created
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file

source

pub fn create_file_with_progress<N, D, F>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, progress_func: F ) -> Result<ProjectFile, ()>
where N: BnStrCompatible, D: BnStrCompatible, F: FnMut(usize, usize) -> bool,

Create a file in the project

contents - Bytes of the file that will be created
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
progress_func - Progress function that will be called as the file is being added

source

pub unsafe fn create_file_unsafe<N, D, I>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime ) -> Result<ProjectFile, ()>
where N: BnStrCompatible, D: BnStrCompatible, I: BnStrCompatible,

Create a file in the project

contents - Bytes of the file that will be created
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
id - id unique ID
creation_time - Creation time of the file

source

pub unsafe fn create_file_with_progress_unsafe<N, D, I, F>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime, progress_func: F ) -> Result<ProjectFile, ()>
where N: BnStrCompatible, D: BnStrCompatible, I: BnStrCompatible, F: FnMut(usize, usize) -> bool,

Create a file in the project

contents - Bytes of the file that will be created
folder - Folder to place the created file in
name - Name to assign to the created file
description - Description to assign to the created file
id - id unique ID
creation_time - Creation time of the file
progress_func - Progress function that will be called as the file is being added

source

pub fn files(&self) -> Result<Array<ProjectFile>, ()>

Get a list of files in the project

source

pub fn file_by_id<S: BnStrCompatible>(&self, id: S) -> Option<ProjectFile>

Retrieve a file in the project by unique id

source

pub fn file_by_path<S: BnStrCompatible>(&self, path: S) -> Option<ProjectFile>

Retrieve a file in the project by the path on disk

source

pub fn delete_file(&self, file: &ProjectFile) -> bool

Delete a file from the project

source

pub fn bulk_operation(&mut self) -> Result<ProjectBulkOperationLock<'_>, ()>

A context manager to speed up bulk project operations. Project modifications are synced to disk in chunks, and the project on disk vs in memory may not agree on state if an exception occurs while a bulk operation is happening.

if let Ok(bulk) = project.bulk_operation() {
    for file in std::fs::read_dir("/bin/").unwrap().into_iter() {
        let file = file.unwrap();
        let file_type = file.file_type().unwrap();
        if file_type.is_file() && !file_type.is_symlink() {
            bulk.create_file_from_path(
                "/bin/",
                None,
                &file.file_name().to_string_lossy(),
                "",
            ).unwrap();
        }
    }
}