Struct lsp_types::DocumentLink

pub struct DocumentLink {
    pub range: Range,
    pub target: Option<Url>,
    pub tooltip: Option<String>,
    pub data: Option<Value>,
}

A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.

Fields

range: Range

The range this link applies to.

target: Option<Url>

The uri this link points to.

tooltip: Option<String>

The tooltip text when you hover over this link.

If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as {0} (ctrl + click). The specific instructions vary depending on OS, user settings, and localization.

data: Option<Value>

A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

Trait Implementations

impl Clone for DocumentLink

fn clone(&self) -> DocumentLink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentLink

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentLink

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<DocumentLink> for DocumentLink

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DocumentLink

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

Serialize this value into the given Serde serializer.

impl Eq for DocumentLink

impl StructuralEq for DocumentLink

impl StructuralPartialEq for DocumentLink