Class: LanguageServer::Protocol::Interface::FileOperationClientCapabilities

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/file_operation_client_capabilities.rb

Overview

Capabilities relating to events from file operations by the user in the client.

These events do not come from the file system, they come from user operations like renaming a file in the UI.

Since:

  • 3.16.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dynamic_registration: nil, did_create: nil, will_create: nil, did_rename: nil, will_rename: nil, did_delete: nil, will_delete: nil) ⇒ FileOperationClientCapabilities

Returns a new instance of FileOperationClientCapabilities.

Since:

  • 3.16.0



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 13

def initialize(dynamic_registration: nil, did_create: nil, will_create: nil, did_rename: nil, will_rename: nil, did_delete: nil, will_delete: nil)
  @attributes = {}

  @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
  @attributes[:didCreate] = did_create if did_create
  @attributes[:willCreate] = will_create if will_create
  @attributes[:didRename] = did_rename if did_rename
  @attributes[:willRename] = will_rename if will_rename
  @attributes[:didDelete] = did_delete if did_delete
  @attributes[:willDelete] = will_delete if will_delete

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Since:

  • 3.16.0



83
84
85
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 83

def attributes
  @attributes
end

Instance Method Details

#did_create ⇒ boolean | nil

The client has support for sending didCreateFiles notifications.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



39
40
41
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 39

def did_create
  attributes.fetch(:didCreate)
end

#did_delete ⇒ boolean | nil

The client has support for sending didDeleteFiles notifications.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



71
72
73
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 71

def did_delete
  attributes.fetch(:didDelete)
end

#did_rename ⇒ boolean | nil

The client has support for sending didRenameFiles notifications.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



55
56
57
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 55

def did_rename
  attributes.fetch(:didRename)
end

#dynamic_registration ⇒ boolean | nil

Whether the client supports dynamic registration for file requests/notifications.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



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

def dynamic_registration
  attributes.fetch(:dynamicRegistration)
end

#to_hash ⇒ Object

Since:

  • 3.16.0



85
86
87
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 85

def to_hash
  attributes
end

#to_json(*args) ⇒ Object

Since:

  • 3.16.0



89
90
91
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 89

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

#will_create ⇒ boolean | nil

The client has support for sending willCreateFiles requests.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



47
48
49
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 47

def will_create
  attributes.fetch(:willCreate)
end

#will_delete ⇒ boolean | nil

The client has support for sending willDeleteFiles requests.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



79
80
81
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 79

def will_delete
  attributes.fetch(:willDelete)
end

#will_rename ⇒ boolean | nil

The client has support for sending willRenameFiles requests.

Returns:

  • (boolean | nil)

Since:

  • 3.16.0



63
64
65
 
# File 'lib/language_server/protocol/interface/file_operation_client_capabilities.rb', line 63

def will_rename
  attributes.fetch(:willRename)
end