Struct NavigationTarget

pub struct NavigationTarget {
    pub file_id: FileId,
    pub full_range: TextRange,
    pub focus_range: Option<TextRange>,
    pub name: SmolStr,
    pub kind: Option<SymbolKind>,
    pub container_name: Option<SmolStr>,
    pub description: Option<String>,
    pub docs: Option<Documentation>,
    pub alias: Option<SmolStr>,
}

NavigationTarget represents an element in the editor’s UI which you can click on to navigate to a particular piece of code.

Typically, a NavigationTarget corresponds to some element in the source code, like a function or a struct, but this is not strictly required.

Fields

file_id: FileId

full_range: TextRange

Range which encompasses the whole element.

Should include body, doc comments, attributes, etc.

Clients should use this range to answer “is the cursor inside the element?” question.

focus_range: Option<TextRange>

A “most interesting” range within the full_range.

Typically, full_range is the whole syntax node, including doc comments, and focus_range is the range of the identifier.

Clients should place the cursor on this range when navigating to this target.

This range must be contained within Self::full_range.

name: SmolStr

kind: Option<SymbolKind>

container_name: Option<SmolStr>

description: Option<String>

docs: Option<Documentation>

alias: Option<SmolStr>

In addition to a name field, a NavigationTarget may also be aliased In such cases we want a NavigationTarget to be accessible by its alias

Implementations

impl NavigationTarget

pub fn focus_or_full_range(&self) -> TextRange

Trait Implementations

impl Clone for NavigationTarget

fn clone(&self) -> NavigationTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NavigationTarget

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

Formats the value using the given formatter.

impl Hash for NavigationTarget

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NavigationTarget

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NavigationTarget

impl StructuralPartialEq for NavigationTarget