Class: LanguageServer::Protocol::Interface::InitializeParams
- Inherits:
-
Object
- Object
- LanguageServer::Protocol::Interface::InitializeParams
- Defined in:
- lib/language_server/protocol/interface/initialize_params.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
Instance Method Summary collapse
-
#capabilities ⇒ ClientCapabilities
The capabilities provided by the client (editor or tool).
-
#initialization_options ⇒ any
User provided initialization options.
-
#initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil) ⇒ InitializeParams
constructor
A new instance of InitializeParams.
-
#process_id ⇒ number
The process Id of the parent process that started the server.
-
#root_path ⇒ string
The rootPath of the workspace.
-
#root_uri ⇒ string
The rootUri of the workspace.
- #to_hash ⇒ Object
- #to_json(*args) ⇒ Object
-
#trace ⇒ "off" | "messages" | "verbose"
The initial trace setting.
-
#workspace_folders ⇒ WorkspaceFolder[]
The workspace folders configured in the client when the server starts.
Constructor Details
#initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil) ⇒ InitializeParams
Returns a new instance of InitializeParams.
5 6 7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 5 def initialize(process_id:, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil) @attributes = {} @attributes[:processId] = process_id @attributes[:rootPath] = root_path if root_path @attributes[:rootUri] = root_uri @attributes[:initializationOptions] = if @attributes[:capabilities] = capabilities @attributes[:trace] = trace if trace @attributes[:workspaceFolders] = workspace_folders if workspace_folders @attributes.freeze end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
85 86 87 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 85 def attributes @attributes end |
Instance Method Details
#capabilities ⇒ ClientCapabilities
The capabilities provided by the client (editor or tool)
60 61 62 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 60 def capabilities attributes.fetch(:capabilities) end |
#initialization_options ⇒ any
User provided initialization options.
52 53 54 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 52 def attributes.fetch(:initializationOptions) end |
#process_id ⇒ number
The process Id of the parent process that started the server. Is null if the process has not been started by another process. If the parent process is not alive then the server should exit (see exit notification) its process.
25 26 27 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 25 def process_id attributes.fetch(:processId) end |
#root_path ⇒ string
The rootPath of the workspace. Is null if no folder is open.
34 35 36 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 34 def root_path attributes.fetch(:rootPath) end |
#root_uri ⇒ string
The rootUri of the workspace. Is null if no folder is open. If both ‘rootPath` and `rootUri` are set `rootUri` wins.
44 45 46 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 44 def root_uri attributes.fetch(:rootUri) end |
#to_hash ⇒ Object
87 88 89 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 87 def to_hash attributes end |
#to_json(*args) ⇒ Object
91 92 93 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 91 def to_json(*args) to_hash.to_json(*args) end |
#trace ⇒ "off" | "messages" | "verbose"
The initial trace setting. If omitted trace is disabled (‘off’).
68 69 70 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 68 def trace attributes.fetch(:trace) end |
#workspace_folders ⇒ WorkspaceFolder[]
The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be ‘null` if the client supports workspace folders but none are configured.
Since 3.6.0
81 82 83 |
# File 'lib/language_server/protocol/interface/initialize_params.rb', line 81 def workspace_folders attributes.fetch(:workspaceFolders) end |