pub struct CoreSimilarityProvider { /* private fields */ }Expand description
A core-backed similarity provider.
Implementations§
Source§impl CoreSimilarityProvider
impl CoreSimilarityProvider
pub unsafe fn from_raw(handle: *mut BNSimilarityProvider) -> Self
pub unsafe fn ref_from_raw(handle: *mut BNSimilarityProvider) -> Ref<Self>
Sourcepub fn id(&self) -> SimilarityProviderId
pub fn id(&self) -> SimilarityProviderId
Returns the provider’s ID.
Sourcepub fn create<C: SimilarityProvider>(
ty: &CoreSimilarityProviderType,
provider: C,
) -> Ref<CoreSimilarityProvider>
pub fn create<C: SimilarityProvider>( ty: &CoreSimilarityProviderType, provider: C, ) -> Ref<CoreSimilarityProvider>
Wraps a custom provider in a core provider.
Sourcepub fn provider_type(&self) -> CoreSimilarityProviderType
pub fn provider_type(&self) -> CoreSimilarityProviderType
Returns the registered type that created this provider.
Sourcepub fn visit_node(
&self,
node: &SimilaritySessionNode,
completion: &SimilaritySessionCompletion,
)
pub fn visit_node( &self, node: &SimilaritySessionNode, completion: &SimilaritySessionCompletion, )
Performs a complete node visit with the core managing result updates.
Sourcepub fn visit_node_edge(
&self,
from: &SimilaritySessionNode,
to: &SimilaritySessionNode,
completion: &SimilaritySessionCompletion,
)
pub fn visit_node_edge( &self, from: &SimilaritySessionNode, to: &SimilaritySessionNode, completion: &SimilaritySessionCompletion, )
Performs a complete edge visit with the core managing result updates.
Sourcepub fn perform_visit_node(
&self,
node: &SimilaritySessionNode,
results: &mut SimilarityProviderResults<'_>,
completion: &SimilaritySessionCompletion,
) -> bool
pub fn perform_visit_node( &self, node: &SimilaritySessionNode, results: &mut SimilarityProviderResults<'_>, completion: &SimilaritySessionCompletion, ) -> bool
Calls this provider’s node visit with an existing result writer.
Sourcepub fn perform_visit_node_edge(
&self,
from: &SimilaritySessionNode,
to: &SimilaritySessionNode,
results: &mut SimilarityProviderResults<'_>,
completion: &SimilaritySessionCompletion,
) -> bool
pub fn perform_visit_node_edge( &self, from: &SimilaritySessionNode, to: &SimilaritySessionNode, results: &mut SimilarityProviderResults<'_>, completion: &SimilaritySessionCompletion, ) -> bool
Calls this provider’s edge visit with an existing result writer.
Sourcepub fn result_name(
&self,
node: &SimilaritySessionNode,
entity: SimilarityEntityId,
result: SimilarityResultId,
) -> Option<String>
pub fn result_name( &self, node: &SimilaritySessionNode, entity: SimilarityEntityId, result: SimilarityResultId, ) -> Option<String>
Returns the display name for a result.
Sourcepub fn apply_result(
&self,
node: &SimilaritySessionNode,
entity: SimilarityEntityId,
result: SimilarityResultId,
) -> SimilarityApplyStatus
pub fn apply_result( &self, node: &SimilaritySessionNode, entity: SimilarityEntityId, result: SimilarityResultId, ) -> SimilarityApplyStatus
Applies a result.
Sourcepub fn render_result(
&self,
node: &SimilaritySessionNode,
entity: SimilarityEntityId,
context: &SimilarityRenderContext,
result: SimilarityResultId,
)
pub fn render_result( &self, node: &SimilaritySessionNode, entity: SimilarityEntityId, context: &SimilarityRenderContext, result: SimilarityResultId, )
Adds views for a result to a render context.
Trait Implementations§
Source§impl ToOwned for CoreSimilarityProvider
impl ToOwned for CoreSimilarityProvider
Source§type Owned = Ref<CoreSimilarityProvider>
type Owned = Ref<CoreSimilarityProvider>
The resulting type after obtaining ownership.
Source§fn to_owned(&self) -> Self::Owned
fn to_owned(&self) -> Self::Owned
Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · Source§fn clone_into(&self, target: &mut Self::Owned)
fn clone_into(&self, target: &mut Self::Owned)
Uses borrowed data to replace owned data, usually by cloning. Read more
impl Send for CoreSimilarityProvider
impl Sync for CoreSimilarityProvider
Auto Trait Implementations§
impl Freeze for CoreSimilarityProvider
impl RefUnwindSafe for CoreSimilarityProvider
impl Unpin for CoreSimilarityProvider
impl UnsafeUnpin for CoreSimilarityProvider
impl UnwindSafe for CoreSimilarityProvider
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more