Struct SignatureHelp 

pub struct SignatureHelp {
    pub signatures: Vec<SignatureInformation>,
    pub active_signature: Option<u32>,
    pub active_parameter: Option<ActiveParameter>,
}

Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.

Fields

signatures: Vec<SignatureInformation>

One or more signatures.

active_signature: Option<u32>

The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures.

Whenever possible implementors should make an active decision about the active signature and shouldn’t rely on a default value.

In future version of the protocol this property might become mandatory to better express this.

active_parameter: Option<ActiveParameter>

The active parameter of the active signature.

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 omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters.

If the active signature has no parameters it is ignored.

In future version of the protocol this property might become mandatory (but still nullable) to better express the active parameter if the active signature does have any.

Implementations

impl SignatureHelp

pub const fn new( signatures: Vec<SignatureInformation>, active_signature: Option<u32>, active_parameter: Option<ActiveParameter>, ) -> Self

Trait Implementations

impl Clone for SignatureHelp

fn clone(&self) -> SignatureHelp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureHelp

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

Formats the value using the given formatter.

impl Default for SignatureHelp

fn default() -> SignatureHelp

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignatureHelp

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SignatureHelp

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 SignatureHelp

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

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 SignatureHelp

impl StructuralPartialEq for SignatureHelp