Class: LanguageServer::Protocol::Interface::WorkspaceSymbolClientCapabilities

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb,
sig/language_server/protocol/interface/workspace_symbol_client_capabilities.rbs

Overview

Client capabilities for a WorkspaceSymbolRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil, resolve_support: nil) ⇒ WorkspaceSymbolClientCapabilities

Returns a new instance of WorkspaceSymbolClientCapabilities.

Parameters:

  • dynamic_registration: (Boolean) (defaults to: nil)
  • symbol_kind: (Object) (defaults to: nil)
  • tag_support: (Object) (defaults to: nil)
  • resolve_support: (Object) (defaults to: nil) 


8
9
10
11
12
13
14
15
16
17
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 8

def initialize(dynamic_registration: nil, symbol_kind: nil, tag_support: nil, resolve_support: nil)
  @attributes = {}

  @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
  @attributes[:symbolKind] = symbol_kind if symbol_kind
  @attributes[:tagSupport] = tag_support if tag_support
  @attributes[:resolveSupport] = resolve_support if resolve_support

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Hash[Symbol, untyped] (readonly)

Returns the value of attribute attributes.

Returns:

  • (Hash[Symbol, untyped]) 


58
59
60
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 58

def attributes
  @attributes
end

Instance Method Details

#dynamic_registration ⇒ boolean

Symbol request supports dynamic registration.

Returns:

  • (boolean) 


23
24
25
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 23

def dynamic_registration
  attributes.fetch(:dynamicRegistration)
end

#resolve_support ⇒ { properties: string[]; }

The client support partial workspace symbols. The client will send the request workspaceSymbol/resolve to the server to resolve additional properties.

Returns:

  • ({ properties: string[]; })

Since:

  • 3.17.0



54
55
56
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 54

def resolve_support
  attributes.fetch(:resolveSupport)
end

#symbol_kind ⇒ { valueSet?: SymbolKind[]; }

Specific capabilities for the SymbolKind in the workspace/symbol request.

Returns:

  • ({ valueSet?: SymbolKind[]; }) 


31
32
33
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 31

def symbol_kind
  attributes.fetch(:symbolKind)
end

#tag_support ⇒ { valueSet: SymbolTag[]; }

The client supports tags on SymbolInformation. Clients supporting tags have to handle unknown tags gracefully.

Returns:

  • ({ valueSet: SymbolTag[]; })

Since:

  • 3.16.0



42
43
44
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 42

def tag_support
  attributes.fetch(:tagSupport)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


60
61
62
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 60

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String) 


64
65
66
 
# File 'lib/language_server/protocol/interface/workspace_symbol_client_capabilities.rb', line 64

def to_json(*args)
  to_hash.to_json(*args)
end