Struct Inventory 

pub struct Inventory { /* private fields */ }

The core of the plugin system

It scans system directories and collects valid memflow plugins. They can then be instantiated easily. The reason the libraries are collected is to allow for reuse, and save performance

Examples

Creating a OS instance, the recommended way:

use memflow::plugins::Inventory;
let mut inventory = Inventory::scan();
inventory
  .builder()
  .connector("qemu")
  .os("win32")
  .build()

Nesting connectors and os plugins:

use memflow::plugins::{Inventory, Args};
let mut inventory = Inventory::scan();
let os = inventory
  .builder()
  .connector("qemu")
  .os("linux")
  .connector("qemu")
  .os("win32")
  .build();

Implementations

impl Inventory

pub fn empty() -> Self

Creates an empty inventory.

pub fn new() -> Self

Creates a new inventory of plugins from the default plugin installation path. The default plugin installation path is also the one used by memflowup.

Examples

Creating a inventory:

use memflow::plugins::Inventory;

let mut inventory = Inventory::new();

pub fn scan_path<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new inventory of plugins from the provided path. The path has to be a valid directory or the function will fail with an Error::IO error.

Examples

Creating a inventory:

use memflow::plugins::Inventory;

let mut inventory = Inventory::scan_path("./")
    .unwrap();

pub fn scan() -> Self

Creates a new inventory of plugins by searching various paths.

It will query PATH, and an additional set of of directories (standard unix ones, if unix, and “HOME/.local/lib” on all OSes) for “memflow” directory, and if there is one, then search for libraries in there.

Examples

Creating an inventory:

use memflow::plugins::Inventory;

let mut inventory = Inventory::scan();

pub fn add_cargo_workspace(self) -> Result<Self>

Adds cargo workspace to the inventory

This function is used behind the scenes by the documentation, however, is not particularly useful for end users.

pub fn add_dir<P: AsRef<Path>>(&mut self, path: P) -> Result<&Self>

Adds a library directory to the inventory

Safety

Same as previous functions - compiler can not guarantee the safety of third party library implementations.

pub fn add_file<P: AsRef<Path>>(&mut self, path: P) -> Result<&Self>

pub fn builder(&mut self) -> BuilderEmpty<'_>

Creates a new Connector / OS builder.

Examples

Create a connector:

use memflow::plugins::Inventory;

let mut inventory = Inventory::scan();
let os = inventory
  .builder()
  .connector("qemu")
  .build();

Create a Connector with arguments:

use memflow::plugins::{Inventory, Args};

let mut inventory = Inventory::scan();
let os = inventory
  .builder()
  .connector("qemu")
  .args(str::parse("vm-win10").unwrap())
  .build();

Create a Connector and OS with arguments:

use memflow::plugins::{Inventory, Args};

let mut inventory = Inventory::scan();
let os = inventory
  .builder()
  .connector("qemu")
  .args(str::parse("vm-win10").unwrap())
  .os("win10")
  .build();

Create a OS without a connector and arguments:

use memflow::plugins::Inventory;

let mut inventory = Inventory::scan();
let os = inventory
  .builder()
  .os("native")
  .build();

pub fn instantiate_connector( &mut self, name: &str, input: ConnectorInputArg, args: Option<&ConnectorArgs>, ) -> Result<ConnectorInstanceArcBox<'static>>

Instantiates a new connector instance. The instance will be initialized with the args provided to this call.

In case no connector could be found this will throw an Error::Library.

Safety

This function assumes all libraries were loaded with appropriate safety checks in place. This function is safe, but can crash if previous checks fail.

Examples

Creating a connector instance:

use memflow::plugins::{Inventory, Args};

let mut inventory = Inventory::scan_path("./").unwrap();
let connector = inventory
    .instantiate_connector("coredump", None, None)
    .unwrap();

Defining a dynamically loaded connector:

use memflow::error::Result;
use memflow::types::size;
use memflow::dummy::DummyMemory;
use memflow::plugins::ConnectorArgs;
use memflow::derive::connector;
use memflow::mem::phys_mem::*;

#[connector(name = "dummy_conn")]
pub fn create_connector(_args: &ConnectorArgs) -> Result<DummyMemory> {
    Ok(DummyMemory::new(size::mb(16)))
}

pub fn create_connector( &mut self, name: &str, input: ConnectorInputArg, args: Option<&ConnectorArgs>, ) -> Result<ConnectorInstanceArcBox<'static>>

👎Deprecated: use instantiate_connector instead

pub fn instantiate_os( &mut self, name: &str, input: OsInputArg, args: Option<&OsArgs>, ) -> Result<OsInstanceArcBox<'static>>

Instantiates a new connector instance. The instance will be initialized with the args provided to this call.

In case no connector could be found this will throw an Error::Library.

Safety

This function assumes all libraries were loaded with appropriate safety checks in place. This function is safe, but can crash if previous checks fail.

Examples

Creating a OS instance with custom arguments

use memflow::plugins::{Inventory, ConnectorArgs};

let args = str::parse(":4m").unwrap();
let os = inventory.instantiate_os("dummy", None, Some(&args))
    .unwrap();
std::mem::drop(os);

pub fn create_os( &mut self, name: &str, input: OsInputArg, args: Option<&OsArgs>, ) -> Result<OsInstanceArcBox<'static>>

👎Deprecated: use instantiate_os instead

pub fn set_max_log_level(&self, level: LevelFilter)

Sets the maximum logging level in all plugins and updates the internal [PluginLogger] in each plugin instance.

pub fn available_connectors(&self) -> Vec<String>

Returns the names of all currently available connectors that can be used.

pub fn available_os(&self) -> Vec<String>

Returns the names of all currently available os plugins that can be used.

pub fn connector_help(&mut self, name: &str) -> Result<String>

Returns the help string of the given Connector.

This function returns an error in case the Connector was not found or does not implement the help feature.

pub fn os_help(&mut self, name: &str) -> Result<String>

Returns the help string of the given Os Plugin.

This function returns an error in case the Os Plugin was not found or does not implement the help feature.

pub fn connector_target_list(&mut self, name: &str) -> Result<Vec<TargetInfo>>

Returns a list of all available targets of the connector.

This function returns an error in case the connector does not implement this feature.

Trait Implementations

impl Clone for Inventory

fn clone(&self) -> Inventory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Inventory

fn default() -> Self

Returns the “default value” for a type.