Struct SimilaritySessionNode 

pub struct SimilaritySessionNode { /* private fields */ }

The main unit of similarity processing.

Implementations

impl SimilaritySessionNode

pub fn new(view: &BinaryView) -> Ref<Self>

Creates a node for an open view and schedules its functions.

pub fn new_from_file(file: &FileMetadata) -> Ref<Self>

Creates a node that opens its view and schedules its functions when run.

The session closes the view when the run no longer needs it, so the view may be unavailable at other times.

pub unsafe fn from_raw(handle: *mut BNSimilaritySessionNode) -> Self

pub unsafe fn ref_from_raw(handle: *mut BNSimilaritySessionNode) -> Ref<Self>

pub fn view(&self) -> Option<Ref<BinaryView>>

Returns the node’s open view if one is available.

If the node was created with SimilaritySessionNode::new_from_file, its view may be unavailable outside a session run. The session closes the view when the run no longer needs it.

pub fn set_view(&self, view: Option<&BinaryView>)

Replaces the node’s view and creates entities for its functions.

A view backed by a different FileMetadata is ignored. Do not mix files.

pub fn file(&self) -> Ref<FileMetadata>

Returns the file used by the node.

pub fn load_options(&self) -> Ref<Settings>

Returns the settings used when this node opens its view.

Modify the returned settings before running the session.

pub fn id(&self) -> SimilaritySessionNodeId

Returns the node’s ID.

pub fn create_entity(&self, info: SimilarityEntityInfo) -> SimilarityEntityId

Adds an entity without scheduling it.

An existing entity with the same type and address is reused. A non-empty name refreshes its display name.

pub fn remove_entity(&self, id: SimilarityEntityId) -> bool

Removes an entity, its schedule, its provider results, and its selected result.

If you are looking to unschedule an entity, use SimilaritySessionNode::remove_scheduled_entity.

pub fn entity(&self, id: SimilarityEntityId) -> Option<SimilarityEntityInfo>

Returns information about an entity.

pub fn entities(&self) -> Array<SimilarityEntityId>

Returns all entities in the node, including entities used only as match targets.

pub fn add_scheduled_entity(&self, id: SimilarityEntityId) -> bool

Schedules an entity for the next provider round.

The session consumes each scheduled batch before resolution. Resolvers can schedule an entity again to request another round.

New nodes schedule all available entities, so this is mainly needed for entities added later.

pub fn remove_scheduled_entity(&self, id: SimilarityEntityId) -> bool

Unschedules an entity without removing it from the node.

If you are looking to remove an entity, use SimilaritySessionNode::remove_entity.

pub fn scheduled_entities(&self) -> Array<SimilarityEntityId>

Returns the entities waiting for provider processing.

pub fn entity_function(&self, id: SimilarityEntityId) -> Option<Ref<Function>>

Returns the function represented by an entity, if it is available.

pub fn results(&self, entity: SimilarityEntityId) -> Vec<SimilarityResultId>

Returns the result IDs for an entity.

pub fn result(&self, result: SimilarityResultId) -> Option<SimilarityResult>

Returns a stored result by its ID, which is unique within the node.

pub fn apply_target( &self, entity: SimilarityEntityId, target: SimilarityEntityRef, ) -> SimilarityApplyStatus

Applies the standard metadata transfer from a target entity.

pub fn set_resolved_result( &self, entity: SimilarityEntityId, result: SimilarityResultId, ) -> bool

Selects a provider result for an entity.

pub fn resolved_result( &self, entity: SimilarityEntityId, ) -> Option<SimilarityResultId>

Returns the selected result for an entity.

pub fn clear_resolved_result(&self, entity: SimilarityEntityId) -> bool

Clears the selected result for an entity.

pub fn incoming_edges(&self) -> Vec<SimilaritySessionNodeId>

Returns the IDs of nodes with edges into this node, in ascending order.

pub fn outgoing_edges(&self) -> Vec<SimilaritySessionNodeId>

Returns the IDs of nodes with edges out of this node, in ascending order.

pub fn incoming_nodes(&self) -> Array<SimilaritySessionNode>

Returns nodes with edges into this node, ordered by ID.

pub fn outgoing_nodes(&self) -> Array<SimilaritySessionNode>

Returns nodes with edges out of this node, ordered by ID.

Trait Implementations

impl CoreArrayProvider for SimilaritySessionNode

type Raw = *mut BNSimilaritySessionNode

type Context = ()

type Wrapped<'a> = Guard<'a, SimilaritySessionNode>

impl ToOwned for SimilaritySessionNode

type Owned = Ref<SimilaritySessionNode>

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.