class Async::Clock

@public Since *Async v1*.
A convenient wrapper around the internal monotonic clock.

@returns [Numeric] The total execution time.
@yields {...} The block to execute.
Measure the execution of a block of code.

def self.measure
	start_time = self.now
	
	yield
	
	return self.now - start_time
end

Get the current elapsed monotonic time.

def self.now
	::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
end

@returns [Clock]
Start measuring elapsed time from now.

def self.start
	self.new.tap(&:start!)
end

@returns [Hash] The JSON-compatible hash.

Convert the clock to a JSON-compatible hash.

def as_json(...)
	{
		started: self.started,
		total: self.total,
	}
end

@parameter total [Numeric] The initial clock duration.
Create a new clock with the initial total time.

def initialize(total = 0)
	@total = total
	@started = nil
end

Reset the total elapsed time. If the clock is currently running, reset the start time to now.

def reset!
	@total = 0
	
	if @started
		@started = Clock.now
	end
end

Start measuring a duration.

def start!
	@started ||= Clock.now
end

Stop measuring a duration and append the duration to the current total.

def stop!
	if @started
		@total += (Clock.now - @started)
		@started = nil
	end
	
	return @total
end

@returns [String] The JSON string.

Convert the clock to a JSON string.

def to_json(...)
	self.as_json.to_json(...)
end

The total elapsed time including any current duration.

def total
	total = @total
	
	if @started
		total += (Clock.now - @started)
	end
	
	return total
end

Modules