Struct lsp_types::SemanticTokensClientCapabilities

pub struct SemanticTokensClientCapabilities {
    pub dynamic_registration: Option<bool>,
    pub requests: SemanticTokensClientCapabilitiesRequests,
    pub token_types: Vec<SemanticTokenType>,
    pub token_modifiers: Vec<SemanticTokenModifier>,
    pub formats: Vec<TokenFormat>,
    pub overlapping_token_support: Option<bool>,
    pub multiline_token_support: Option<bool>,
    pub server_cancel_support: Option<bool>,
    pub augments_syntax_tokens: Option<bool>,
}

Capabilities specific to the textDocument/semanticTokens/* requests.

@since 3.16.0

Fields

dynamic_registration: Option<bool>

Whether implementation supports dynamic registration. If this is set to true the client supports the new (TextDocumentRegistrationOptions & StaticRegistrationOptions) return value for the corresponding server capability as well.

requests: SemanticTokensClientCapabilitiesRequests

Which requests the client supports and might send to the server depending on the server’s capability. Please note that clients might not show semantic tokens or degrade some of the user experience if a range or full request is advertised by the client but not provided by the server. If for example the client capability requests.full and request.range are both set to true but the server only provides a range provider the client might not render a minimap correctly or might even decide to not show any semantic tokens at all.

token_types: Vec<SemanticTokenType>

The token types that the client supports.

token_modifiers: Vec<SemanticTokenModifier>

The token modifiers that the client supports.

formats: Vec<TokenFormat>

The token formats the clients supports.

overlapping_token_support: Option<bool>

Whether the client supports tokens that can overlap each other.

multiline_token_support: Option<bool>

Whether the client supports tokens that can span multiple lines.

server_cancel_support: Option<bool>

Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning ErrorCodes.ServerCancelled. If a server does the client needs to retrigger the request.

@since 3.17.0

augments_syntax_tokens: Option<bool>

Whether the client uses semantic tokens to augment existing syntax tokens. If set to true client side created syntax tokens and semantic tokens are both used for colorization. If set to false the client only uses the returned semantic tokens for colorization.

If the value is undefined then the client behavior is not specified.

@since 3.17.0

Trait Implementations

impl Clone for SemanticTokensClientCapabilities

fn clone(&self) -> SemanticTokensClientCapabilities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SemanticTokensClientCapabilities

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

Formats the value using the given formatter.

impl Default for SemanticTokensClientCapabilities

fn default() -> SemanticTokensClientCapabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SemanticTokensClientCapabilities

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SemanticTokensClientCapabilities

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

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 SemanticTokensClientCapabilities

impl StructuralEq for SemanticTokensClientCapabilities

impl StructuralPartialEq for SemanticTokensClientCapabilities