Struct Requested 

pub struct Requested {
    pub m: usize,
    pub ef_construction: usize,
    pub ef_runtime: usize,
    pub initial_cap: Option<usize>,
}

What a client asked for when it said HNSW.

Every field is optional because every one of them is optional on the wire, and the whole thing is Copy and public because most of what happens to it is being handed straight back out by FT.INFO.

Fields

m: usize

The graph out degree, which is recorded and echoed and does nothing.

ef_construction: usize

How hard to work while building, which sets the posting size.

ef_runtime: usize

The search beam, which sets the probe and the rerank width.

initial_cap: Option<usize>

How many vectors are coming, so the postings can be there already.

Implementations

impl Requested

pub fn plan(&self, compat: Compat) -> Plan

What to do about it.

pub fn tuning(&self) -> Tuning

The partition index tuning these parameters ask for.

Everything is scaled against the defaults, so a client that set nothing gets exactly Tuning::default and a client that doubled a parameter gets roughly double whatever it controls. The clamps at either end are there because these numbers arrive from the network and nothing stops somebody sending EF_RUNTIME 4000000000.

pub fn capacity(&self) -> usize

How many postings to have ready, from INITIAL_CAP.

Zero when the client did not say, which means grow into it as usual.

Trait Implementations

impl Clone for Requested

fn clone(&self) -> Requested

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Requested

impl Debug for Requested

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

Formats the value using the given formatter.

impl Default for Requested

fn default() -> Requested

What Redis uses when the client set nothing.

impl Eq for Requested

impl PartialEq for Requested

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Requested