Struct SimilaritySessionCompletion 

pub struct SimilaritySessionCompletion { /* private fields */ }

Stop requests, progress, and timing for a session run.

Implementations

impl SimilaritySessionCompletion

pub fn new() -> Ref<Self>

Creates a new completion state, typically only done when calling into providers and resolvers directly instead of from a session.

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

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

pub fn is_finished(&self) -> bool

Returns whether the session run has finished.

pub fn progress(&self, query: SimilaritySessionCompletionQuery) -> f64

Returns progress for the selected part of the run from 0.0 through 1.0.

pub fn request_stop(&self)

Asks the run to stop.

pub fn is_stop_requested(&self) -> bool

Returns whether a stop has been requested.

pub fn set_progress( &self, query: SimilaritySessionCompletionQuery, progress: f64, )

Increases progress for a node and one provider or resolver. Progress cannot decrease.

NOTE: Only call this from the provider or resolver selected by the query.

pub fn timing(&self, query: SimilaritySessionCompletionQuery) -> Duration

Returns timing for the selected part of the run.

Trait Implementations

impl ToOwned for SimilaritySessionCompletion

type Owned = Ref<SimilaritySessionCompletion>

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.

impl Send for SimilaritySessionCompletion

impl Sync for SimilaritySessionCompletion