Class: Steep::Server::WorkDoneProgress

Inherits:
Object
  • Object
show all
Defined in:
lib/steep/server/work_done_progress.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(guid, &block) ⇒ WorkDoneProgress

Returns a new instance of WorkDoneProgress.



6
7
8
9
10
 
# File 'lib/steep/server/work_done_progress.rb', line 6

def initialize(guid, &block)
  @sender = block
  @guid = guid
  @percentage = 0
end

Instance Attribute Details

#guid ⇒ Object (readonly)

Returns the value of attribute guid.



4
5
6
 
# File 'lib/steep/server/work_done_progress.rb', line 4

def guid
  @guid
end

#percentage ⇒ Object (readonly)

Returns the value of attribute percentage.



4
5
6
 
# File 'lib/steep/server/work_done_progress.rb', line 4

def percentage
  @percentage
end

#sender ⇒ Object (readonly)

Returns the value of attribute sender.



4
5
6
 
# File 'lib/steep/server/work_done_progress.rb', line 4

def sender
  @sender
end

Instance Method Details

#begin(title, message = nil, request_id:) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/steep/server/work_done_progress.rb', line 12

def begin(title, message = nil, request_id:)
  sender.call(
    {
      id: request_id,
      method: "window/workDoneProgress/create",
      params: { token: guid }
    }
  )

  value = { kind: "begin", cancellable: false, title: title, percentage: percentage }
  value[:message] = message if message

  sender.call(
    {
      method: "$/progress",
      params: { token: guid, value: value }
    }
  )

  self
end

#end(message = nil) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/steep/server/work_done_progress.rb', line 49

def end(message = nil)
  value = { kind: "end" }
  value[:message] = message if message

  sender.call(
    {
      method: "$/progress",
      params: { token: guid, value: value }
    }
  )

  self
end

#report(percentage, message = nil) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/steep/server/work_done_progress.rb', line 34

def report(percentage, message = nil)
  @percentage = percentage
  value = { kind: "report", percentage: percentage }
  value[:message] = message if message

  sender.call(
    {
      method: "$/progress",
      params: { token: guid, value: value }
    }
  )

  self
end