📂 time

⚡ time::getDate

Get the current date in the given format.

Inputs:

• ${format} as string:

  (optional) the format (see printf) of the date to return

  (defaults to “%(%F_%Hh%Mm%Ss)T”)

Returns:

• ${REPLY}: the current date in the given format.

Example usage:

time::getDate
local date="${REPLY}"
time::getDate format="'%(%Hh%Mm%Ss)T'"

This function avoid to call $(date) in a subshell (date is a an external executable).

⚡ time::getHumanTimeFromMicroseconds

Convert microseconds to human readable format.

Inputs:

• $1: microseconds as int:

  the microseconds to convert

• ${format} as string:

  (optional) the format to use

  Usable formats:

  • %HH: hours
  • %MM: minutes
  • %SS: seconds
  • %LL: milliseconds
  • %h: hours without leading zero
  • %m: minutes without leading zero
  • %s: seconds without leading zero
  • %l: milliseconds without leading zero
  • %u: microseconds without leading zero
  • %M: total minutes
  • %S: total seconds
  • %L: total milliseconds
  • %U: total microseconds

  (defaults to “%HH:%MM:%SS”)

Returns:

• ${REPLY}: the human readable format

Example usage:

time::getHumanTimeFromMicroseconds 123456789
time::getHumanTimeFromMicroseconds 123456789 format="%HH:%MM:%SS"
echo "${REPLY}"

⚡ time::getMicrosecondsFromSeconds

Convert seconds (float number representation) to microseconds. e.g. 1.234567 → 1234567

Inputs:

• $1: seconds as float:

  the seconds to convert

Returns:

• ${REPLY}: The microseconds (integer number).

Example usage:

time::getMicrosecondsFromSeconds 1.234567
echo "${REPLY}"

⚡ time::getProgramElapsedMicroseconds

Get the elapsed time in µs since the program started.

Returns:

• ${REPLY}: the elapsed time in µs since the program started.

Example usage:

time::getProgramElapsedMicroseconds
echo "${REPLY}"
time::getHumanTimeFromMicroseconds "${REPLY}"
echo "Human time: ${REPLY}"

We split the computation in seconds and milliseconds to avoid overflow on 32-bit systems. The 10# forces the base 10 conversion to avoid issues with leading zeros. Fun fact: this function will fail in 2038 on 32-bit systems because the number of seconds will overflow.

⚡ time::getSecondsFromMicroseconds

Convert microseconds to seconds (float number representation). e.g. 1234567 → 1.234567

Inputs:

• $1: microseconds as int:

  the microseconds to convert

• ${precision} as string:

  (optional) The precision to get (number of digits after the dot).

  (defaults to 6)

Returns:

• ${REPLY}: The seconds (float number).

Example usage:

time::getSecondsFromMicroseconds 1234567
time::getSecondsFromMicroseconds 1234567 precision=3
echo "${REPLY}"

⚡ time::getTimerMicroseconds

Get the time elapsed since the call of time::startTimer.

Inputs:

• ${logElapsedTime} as bool:

  (optional) Wether or not to log the elapsed time.

  (defaults to false)

• ${format} as string:

  (optional) The format to use if we log the elapsed time. See time::getHumanTimeFromMicroseconds for the format.

  (defaults to “%S.%LLs”).

Returns:

• ${REPLY}: the elapsed time in microseconds.

Example usage:

time::startTimer
time::getTimerMicroseconds logElapsedTime=true
echo "Total microseconds: ${REPLY}"

⚡ time::isTimeElapsed

Check if a given time in microseconds has elapsed since the last call to this function.

Inputs:

• $1: microseconds as int:

  the microseconds to check

• ${timerName} as int:

  A variable name that will be used to store the last time this function was called. Defaults to the name of the calling function. Can be set to a fixed value if you call this function from different functions and want to share the same timer.

  (defaults to “${FUNCNAME[1]}”)

Returns:

• 0 if the time has elapsed
• 1 if the time has not yet elapsed

Example usage:

if time::isTimeElapsed 500000; then
  echo "500ms has elapsed since the last call to this function"
fi

⚡ time::startTimer

Start a timer. You can then call time::getTimerMicroseconds to get the elapsed time.

Example usage:

time::startTimer
time::getTimerMicroseconds