binaryninja::headless

Struct Session

source
pub struct Session { /* private fields */ }
Expand description

Wrapper for init and shutdown. Instantiating this at the top of your script will initialize everything correctly and then clean itself up at exit as well.

Implementations§

source§

impl Session

source

pub fn new() -> Result<Self, InitializationError>

Before calling new you must make sure that the license is retrievable, otherwise the core won’t be able to initialize.

If you cannot otherwise provide a license via BN_LICENSE_FILE environment variable or the Binary Ninja user directory you can call Session::new_with_opts instead of this function.

source

pub fn new_with_opts( options: InitializationOptions, ) -> Result<Self, InitializationError>

Initialize with options, the same rules apply as Session::new, see InitializationOptions::default for the regular options passed.

This differs from Session::new in that it does not check to see if there is a license that the core can discover by itself, therefore, it is expected that you know where your license is when calling this directly.

source

pub fn load(&self, file_path: impl AsRef<Path>) -> Option<Ref<BinaryView>>

let headless_session = binaryninja::headless::Session::new().unwrap();

let bv = headless_session
    .load("/bin/cat")
    .expect("Couldn't open `/bin/cat`");
source

pub fn load_with_progress( &self, file_path: impl AsRef<Path>, progress: impl ProgressCallback, ) -> Option<Ref<BinaryView>>

Load the file with a progress callback, the callback will only be called for BNDBs currently.

let headless_session = binaryninja::headless::Session::new().unwrap();

let print_progress = |progress, total| {
    println!("{}/{}", progress, total);
    true
};

let bv = headless_session
    .load_with_progress("cat.bndb", print_progress)
    .expect("Couldn't open `cat.bndb`");
source

pub fn load_with_options<O: IntoJson>( &self, file_path: impl AsRef<Path>, update_analysis_and_wait: bool, options: Option<O>, ) -> Option<Ref<BinaryView>>

use binaryninja::{metadata::Metadata, rc::Ref};
use std::collections::HashMap;

let settings: Ref<Metadata> =
    HashMap::from([("analysis.linearSweep.autorun", false.into())]).into();
let headless_session = binaryninja::headless::Session::new().unwrap();

let bv = headless_session
    .load_with_options("/bin/cat", true, Some(settings))
    .expect("Couldn't open `/bin/cat`");
source

pub fn load_with_options_and_progress<O: IntoJson>( &self, file_path: impl AsRef<Path>, update_analysis_and_wait: bool, options: Option<O>, progress: impl ProgressCallback, ) -> Option<Ref<BinaryView>>

Load the file with options and a progress callback, the callback will only be called for BNDBs currently.

use binaryninja::{metadata::Metadata, rc::Ref};
use std::collections::HashMap;

let print_progress = |progress, total| {
    println!("{}/{}", progress, total);
    true
};

let settings: Ref<Metadata> =
    HashMap::from([("analysis.linearSweep.autorun", false.into())]).into();
let headless_session = binaryninja::headless::Session::new().unwrap();

let bv = headless_session
    .load_with_options_and_progress("cat.bndb", true, Some(settings), print_progress)
    .expect("Couldn't open `cat.bndb`");

Trait Implementations§

source§

impl Clone for Session

source§

fn clone(&self) -> Session

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Session

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Session

source§

fn default() -> Session

Returns the “default value” for a type. Read more
source§

impl Drop for Session

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Hash for Session

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Session

source§

fn eq(&self, other: &Session) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Eq for Session

source§

impl StructuralPartialEq for Session

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.