Skip to main content

InsertRanker

Struct InsertRanker 

Source
pub struct InsertRanker;
Expand description

Built-in ranker tuned for Insert-mode completion. Sorts by final_score descending, where:

final_score = base_score                  // matcher output
            + per_source_priority         // CandidateData::Plain → no per-source bias
            + frequency_bonus             // 0–50, host-side LRU
            + preselect_bonus             // +200 for LSP preselect items
            - deprecated_penalty          // -100 for deprecated tags

4.2.g.1 ships only base_score (the matcher’s tier score). Per-source priority + frequency + preselect + deprecated land in 4.2.g.2 (LSP source) and 4.2.g.5 (ranking polish); the host adds them via the existing RawCandidate.data payload before calling the ranker.

Implementations§

Source§

impl InsertRanker

Source

pub const ID: &'static str = "rank:insert"

Source

pub const FREQUENCY_BONUS_CAP: u32 = 50

Cap on the per-item frequency bonus, per docs/dev/architecture/insert-completion.md §3.6.

Source

pub fn new() -> Self

Source

pub fn rank_with_bonus( &self, scored: &mut [ScoredCandidate], bonus: impl Fn(&RawCandidate) -> u32, )

Rank by score + bonus(raw), descending. The host owns the bonus composition: per docs/dev/architecture/insert-completion.md §3.6,

final_score = base_score
            + per_source_priority
            + frequency_bonus       // capped at FREQUENCY_BONUS_CAP
            + preselect_bonus
            - deprecated_penalty

Each term has its own clamp; the ranker doesn’t apply policy because the per-term ranges and signs differ (frequency is bounded; preselect is a fixed jolt; deprecated subtracts). Hosts wrap the live lookups (App::completion_accept_freq, App::priority_for_source, …) into a single bonus closure.

Trait Implementations§

Source§

impl CandidateRanker for InsertRanker

Source§

fn rank(&self, scored: &mut Vec<ScoredCandidate>)

Source§

impl Debug for InsertRanker

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InsertRanker

Source§

fn default() -> InsertRanker

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more