Skip to main content

Item

Struct Item 

Source
pub struct Item {
    pub label: String,
    pub kind: ItemKind,
    pub detail: Option<String>,
    pub description: Option<String>,
    pub documentation_md: Option<String>,
    pub kb_entry: Option<&'static Entry>,
    pub insert_text: String,
    pub is_snippet: bool,
    pub sort_priority: u8,
}

Fields§

§label: String§kind: ItemKind§detail: Option<String>§description: Option<String>§documentation_md: Option<String>

Eagerly-built markdown, for items whose documentation is derived from the catalog or a hand-written snippet blurb. Knowledge-base items leave this None and set Item::kb_entry instead – read through Item::documentation rather than touching either field.

§kb_entry: Option<&'static Entry>

Knowledge-base entry backing this item, when it has one.

Rendering markdown for every built-in keyword, type, and function costs ~2700 render_markdown calls (each one several format!s plus paragraph wrapping) on every completion request, and the client displays exactly one of them. Carrying the entry instead lets the server defer rendering to completionItem/resolve.

§insert_text: String§is_snippet: bool

true when insert_text contains LSP snippet placeholders like $0 or ${1:arg}. The server maps this onto InsertTextFormat::Snippet. Default false.

§sort_priority: u8

Sort priority – lower = appears first in the completion menu. 0 = in-scope columns (from FROM/JOIN), 1 = in-scope tables, 2 = scoped builtins, 3 = catalog-wide tables/functions, 4 = keywords, 5 = catch-all. Default 5 keeps old call-sites safe.

Implementations§

Source§

impl Item

Source

pub fn with_sort(self, p: u8) -> Self

Convenience: set sort_priority in a builder-ish way.

Source

pub fn documentation(&self) -> Option<String>

Markdown documentation for this item, rendering the knowledge-base entry on demand. The single accessor callers should use – documentation_md alone misses every built-in.

Trait Implementations§

Source§

impl Clone for Item

Source§

fn clone(&self) -> Item

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Item

Source§

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

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

impl Default for Item

Source§

fn default() -> Item

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

impl Serialize for Item

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Item

§

impl RefUnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnsafeUnpin for Item

§

impl UnwindSafe for Item

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.