Struct SignatureInformation 

pub struct SignatureInformation {
    pub label: String,
    pub documentation: Option<Documentation>,
    pub parameters: Option<Vec<ParameterInformation>>,
    pub active_parameter: Option<ActiveParameter>,
}

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

Fields

label: String

The label of this signature. Will be shown in the UI.

documentation: Option<Documentation>

The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

parameters: Option<Vec<ParameterInformation>>

The parameters of this signature.

active_parameter: Option<ActiveParameter>

The index of the active parameter.

If null, no parameter of the signature is active (for example a named argument that does not match any declared parameters). This is only valid if the client specifies the client capability textDocument.signatureHelp.noActiveParameterSupport === true

If provided (or null), this is used in place of SignatureHelp.activeParameter.

@since 3.16.0

Implementations

impl SignatureInformation

pub const fn new( label: String, documentation: Option<Documentation>, parameters: Option<Vec<ParameterInformation>>, active_parameter: Option<ActiveParameter>, ) -> Self

Trait Implementations

impl Clone for SignatureInformation

fn clone(&self) -> SignatureInformation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureInformation

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

Formats the value using the given formatter.

impl Default for SignatureInformation

fn default() -> SignatureInformation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignatureInformation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SignatureInformation

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 SignatureInformation

fn eq(&self, other: &SignatureInformation) -> 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 Serialize for SignatureInformation

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 SignatureInformation

impl StructuralPartialEq for SignatureInformation