Struct Retrieval 

pub struct Retrieval {
    pub candidates: Vec<String>,
    pub budget_warning: bool,
    /* private fields */
}

The outcome of KeyframeIndex::retrieve.

Fields

candidates: Vec<String>

Keyframe ids to load and evaluate, most votes first (ties in the order they first got a vote).

budget_warning: bool

A posting overran RETRIEVAL_BUDGET and this layer has not been warned yet: emit BUDGET_DIAGNOSTIC.

Implementations

impl Retrieval

pub fn admits(&self, keyframe_frame: u32) -> bool

Whether a loaded candidate keyframe at keyframe_frame is far enough from the query frame to be a revisit.

Trait Implementations

impl Clone for Retrieval

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Retrieval

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Retrieval

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Retrieval