Struct RecallOptions 

pub struct RecallOptions<'a> {
    pub scope: Option<&'a str>,
    pub kind: Option<MemoryKind>,
    pub anchor_key: Option<&'a str>,
    pub query: Option<&'a str>,
    pub decay: Decay,
    pub applicable_only: bool,
    pub limit: Option<usize>,
}

How to recall.

RecallOptions::default is every live record, ranked, with no age term — the reproducible answer.

Fields

scope: Option<&'a str>

Only records recorded in this namespace, matched exactly.

kind: Option<MemoryKind>

Only records of this kind.

anchor_key: Option<&'a str>

Only records anchored to this node key.

query: Option<&'a str>

Every whitespace-separated token must appear in the record’s body, its anchor key or its anchor path (case-insensitively). A filter, not a scorer: the ranking formula has no lexical term, so which records come back can depend on the query while how they are ranked cannot.

decay: Decay

How age is priced in. Defaults to Decay::None — reproducible recall.

applicable_only: bool

Drop records that do not apply to this tree. Off by default: an unanchored or drifted record is demoted and labelled, not withheld, and a lesson about deleted code is often the one worth reading.

limit: Option<usize>

At most this many records, applied after ranking so a limit returns the best matches rather than the newest ones.

None and Some(0) are the same request: every record. 0 is unlimited here because window is the one place that decides what limit means in this crate, and that is what it decides (issue #375). Recall used to read Some(0) as no records — the third implementation of one parameter that window’s doc warned about, and issue #447.

Trait Implementations

impl<'a> Clone for RecallOptions<'a>

fn clone(&self) -> RecallOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for RecallOptions<'a>

impl<'a> Debug for RecallOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RecallOptions<'a>

fn default() -> RecallOptions<'a>

Returns the “default value” for a type.

impl<'a> Eq for RecallOptions<'a>

impl<'a> PartialEq for RecallOptions<'a>

fn eq(&self, other: &RecallOptions<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for RecallOptions<'a>