Struct SimilaritySession 

pub struct SimilaritySession { /* private fields */ }

Coordinates providers and resolvers across a graph of binaries.

Implementations

impl SimilaritySession

pub fn new() -> Ref<Self>

Creates an empty session.

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

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

pub fn id(&self) -> SimilaritySessionId

Returns the session’s unique ID.

pub fn add_provider(&self, provider: &CoreSimilarityProvider)

Adds a provider and schedules entities processed by earlier runs for the next run.

NOTE: Ignored while a run is active.

pub fn remove_provider(&self, provider: &CoreSimilarityProvider)

Removes a provider, clears its results, and marks affected entities for resolution.

NOTE: Ignored while a run is active.

pub fn update_provider_settings( &self, provider: &CoreSimilarityProvider, settings: &Settings, ) -> bool

Updates a provider already in the session and schedules previously processed entities again.

Returns false during a run, when the provider is absent, or when it rejects the settings.

pub fn provider( &self, id: SimilarityProviderId, ) -> Option<Ref<CoreSimilarityProvider>>

Returns a provider by ID.

pub fn providers(&self) -> Array<CoreSimilarityProvider>

Returns the session’s providers.

pub fn add_resolver(&self, resolver: &CoreSimilaritySessionResolver) -> bool

Adds a resolver created for this session and marks entities processed by earlier runs for resolution.

NOTE: Returns false during a run, for a duplicate, or for a resolver created for another session.

pub fn remove_resolver(&self, resolver: &CoreSimilaritySessionResolver) -> bool

Removes a resolver from the session.

NOTE: Returns false during a run, or if it is absent or belongs to another session.

pub fn update_resolver_settings( &self, resolver: &CoreSimilaritySessionResolver, settings: &Settings, ) -> bool

Updates a resolver already in the session and marks previously processed entities for resolution.

Returns false during a run, when the resolver is absent or belongs to another session, or when it rejects the settings.

pub fn resolver( &self, id: SimilaritySessionResolverId, ) -> Option<Ref<CoreSimilaritySessionResolver>>

Returns a resolver by ID.

pub fn resolvers(&self) -> Array<CoreSimilaritySessionResolver>

Returns the session’s resolvers.

pub fn add_receiver(&self, receiver: &CoreSimilaritySessionReceiver)

Adds an update receiver.

A running session keeps using the receiver list it started with.

pub fn remove_receiver(&self, receiver: &CoreSimilaritySessionReceiver)

Removes an update receiver.

A running session keeps using the receiver list it started with.

pub fn receivers(&self) -> Array<CoreSimilaritySessionReceiver>

Returns the session’s update receivers.

pub fn graph(&self) -> Ref<SimilaritySessionGraph>

Returns the session graph.

pub fn run(&self) -> Ref<SimilaritySessionCompletion>

Starts a background run with the current graph, providers, and resolvers.

Changes to them are ignored until the run finishes.

NOTE: Returns the completion state of the active run when already running.

Trait Implementations

impl ToOwned for SimilaritySession

type Owned = Ref<SimilaritySession>

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.