mtime

Documentation

Overview

Package mtime provides a fast monotonic clock source.

Package mtime provides time operations using a monotonic time source, which is useful when you want to work with elapsed rather than wall time. Based on github.com/aristanetworks/monotime. mtime uses Instants. INSTANTS ARE NOT REAL TIMES, they are only useful for measuring elapsed time.

Index

• func Stopwatch() (elapsed func() time.Duration)
• type Instant
  • func Now() Instant
  • func (i Instant) Add(d time.Duration) Instant
  • func (i Instant) Sub(o Instant) time.Duration

Functions

func Stopwatch

func Stopwatch() (elapsed func() time.Duration)

Stopwatch starts a stopwatch and returns a function that itself returns the amount of time elapsed since the start of the stopwatch.

Types

type Instant

type Instant uint64

An Instant represents an instant in monotonically increasing time. INSTANTS ARE NOT REAL TIMES, they are only useful for measuring elapsed time.

func Now

func Now() Instant

Now() returns an instant in monotonic time

func (Instant) Add

func (i Instant) Add(d time.Duration) Instant

Add adds a duration to an Instant

func (Instant) Sub

func (i Instant) Sub(o Instant) time.Duration

Sub subtracts an Instant from an Instant