Struct Session

pub struct Session { /* private fields */ }

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

impl Session

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.

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.

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`");

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`");

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`");

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

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl Drop for Session

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Session

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 Session

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

impl StructuralPartialEq for Session