Membrane.Time (Membrane Core v0.7.0) View Source

Module containing functions needed to perform handling of time.

Membrane always internally uses nanosecond as a time unit. This is how all time units should represented in the code unless there's a good reason to act differently.

Please note that Erlang VM may internally use different units and that may differ from platform to platform. Still, unless you need to perform calculations that do not touch hardware clock, you should use Membrane units for consistency.

Link to this section Summary

Types

non_neg_t()

t()

Functions

as_days(time)

Returns time in days, represented as a rational number.

as_hours(time)

Returns time in hours, represented as a rational number.

as_microseconds(time)

Returns time in microseconds, represented as a rational number.

as_milliseconds(time)

Returns time in milliseconds, represented as a rational number.

as_minutes(time)

Returns time in minutes, represented as a rational number.

as_nanoseconds(time)

Returns time in nanoseconds, represented as a rational number.

as_seconds(time)

Returns time in seconds, represented as a rational number.

day()

Returns one day in Membrane.Time units.

day(number) deprecated

days(number)

Returns given amount of days in Membrane.Time units.

from_datetime(value)

Converts DateTime to Membrane.Time units.

from_iso8601!(value)

Converts iso8601 string to Membrane.Time units. If value is invalid, throws match error.

from_ntp_timestamp(arg)

Converts NTP timestamp (time since 0h on 1st Jan 1900) into Unix timestamp (time since 1st Jan 1970) represented in Membrane.Time units.

hour()

Returns one hour in Membrane.Time units.

hour(number) deprecated

hours(number)

Returns given amount of hours in Membrane.Time units.

is_t(value) deprecated

is_time(value)

Checks whether a value is Membrane.Time.t.

microsecond()

Returns one microsecond in Membrane.Time units.

microsecond(number) deprecated

microseconds(number)

Returns given amount of microseconds in Membrane.Time units.

millisecond()

Returns one millisecond in Membrane.Time units.

millisecond(number) deprecated

milliseconds(number)

Returns given amount of milliseconds in Membrane.Time units.

minute()

Returns one minute in Membrane.Time units.

minute(number) deprecated

minutes(number)

Returns given amount of minutes in Membrane.Time units.

monotonic_time()

Returns current monotonic time based on System.monotonic_time/0 in Membrane.Time units.

nanosecond()

Returns one nanosecond in Membrane.Time units.

nanosecond(number) deprecated

nanoseconds(number)

Returns given amount of nanoseconds in Membrane.Time units.

native_unit()

Returns one VM native unit in Membrane.Time units.

native_unit(number) deprecated

native_units(number)

Returns given amount of VM native units in Membrane.Time units.

os_time()

Returns current POSIX time of operating system based on System.os_time/0 in Membrane.Time units.

pretty_duration(time)

Returns duration as a string with unit. Chosen unit is the biggest possible that doesn't involve precission loss.

pretty_now()

Returns current time in pretty format (currently iso8601), as string Uses system_time/0 under the hood.

second()

Returns one second in Membrane.Time units.

second(number) deprecated

seconds(number)

Returns given amount of seconds in Membrane.Time units.

system_time() deprecated

Returns current time of Erlang VM based on System.system_time/0 in Membrane.Time units.

to_code(time)

Returns quoted code producing given amount time. Chosen unit is the biggest possible that doesn't involve precission loss.

to_code_str(time)

Returns string representation of result of to_code/1.

to_datetime(value)

Returns time as a DateTime struct. TimeZone is set to UTC.

to_days(time)

Returns time in days. Rounded using Kernel.round/1.

to_hours(time)

Returns time in hours. Rounded using Kernel.round/1.

to_iso8601(value)

Returns time as a iso8601 string.

to_microseconds(time)

Returns time in microseconds. Rounded using Kernel.round/1.

to_milliseconds(time)

Returns time in milliseconds. Rounded using Kernel.round/1.

to_minutes(time)

Returns time in minutes. Rounded using Kernel.round/1.

to_nanoseconds(time)

Returns time in nanoseconds. Rounded using Kernel.round/1.

to_native_units(value)

Returns time in VM native units. Rounded using Kernel.round/1.

to_ntp_timestamp(timestamp)

Converts the timestamp into NTP timestamp. May introduce small rounding errors.

to_seconds(time)

Returns time in seconds. Rounded using Kernel.round/1.

vm_time()

Returns current Erlang VM system time based on System.system_time/0 in Membrane.Time units.

Link to this section Types

non_neg_t()

Specs

non_neg_t() :: non_neg_integer()

t()

Specs

t() :: integer()

Link to this section Functions

as_days(time)

Specs

as_days(t()) :: integer() | Ratio.t()

Returns time in days, represented as a rational number.

as_hours(time)

Specs

as_hours(t()) :: integer() | Ratio.t()

Returns time in hours, represented as a rational number.

as_microseconds(time)

Specs

as_microseconds(t()) :: integer() | Ratio.t()

Returns time in microseconds, represented as a rational number.

as_milliseconds(time)

Specs

as_milliseconds(t()) :: integer() | Ratio.t()

Returns time in milliseconds, represented as a rational number.

as_minutes(time)

Specs

as_minutes(t()) :: integer() | Ratio.t()

Returns time in minutes, represented as a rational number.

as_nanoseconds(time)

Specs

as_nanoseconds(t()) :: integer() | Ratio.t()

Returns time in nanoseconds, represented as a rational number.

as_seconds(time)

Specs

as_seconds(t()) :: integer() | Ratio.t()

Returns time in seconds, represented as a rational number.

day()

Specs

day() :: t()

Returns one day in Membrane.Time units.

day(number)

This function is deprecated. Use `day/0` or `days/1` instead..

Specs

day(integer()) :: t()

days(number)

Specs

days(integer()) :: t()

Returns given amount of days in Membrane.Time units.

from_datetime(value)

Specs

from_datetime(DateTime.t()) :: t()

Converts DateTime to Membrane.Time units.

from_iso8601!(value)

Specs

from_iso8601!(String.t()) :: t()

Converts iso8601 string to Membrane.Time units. If value is invalid, throws match error.

from_ntp_timestamp(arg)

Specs

from_ntp_timestamp(ntp_time :: <<_::64>>) :: t()

Converts NTP timestamp (time since 0h on 1st Jan 1900) into Unix timestamp (time since 1st Jan 1970) represented in Membrane.Time units.

NTP timestamp uses fixed point representation with the integer part in the first 32 bits and the fractional part in the last 32 bits.

hour()

Specs

hour() :: t()

Returns one hour in Membrane.Time units.

hour(number)

This function is deprecated. Use `hour/0` or `hours/1` instead..

Specs

hour(integer()) :: t()

hours(number)

Specs

hours(integer()) :: t()

Returns given amount of hours in Membrane.Time units.

is_t(value)

(macro)

This macro is deprecated. Use `is_time/1` instead.

is_time(value)

(macro)

Checks whether a value is Membrane.Time.t.

microsecond()

Specs

microsecond() :: t()

Returns one microsecond in Membrane.Time units.

microsecond(number)

This function is deprecated. Use `microsecond/0` or `microseconds/1` instead..

Specs

microsecond(integer()) :: t()

microseconds(number)

Specs

microseconds(integer()) :: t()

Returns given amount of microseconds in Membrane.Time units.

millisecond()

Specs

millisecond() :: t()

Returns one millisecond in Membrane.Time units.

millisecond(number)

This function is deprecated. Use `millisecond/0` or `milliseconds/1` instead..

Specs

millisecond(integer()) :: t()

milliseconds(number)

Specs

milliseconds(integer()) :: t()

Returns given amount of milliseconds in Membrane.Time units.

minute()

Specs

minute() :: t()

Returns one minute in Membrane.Time units.

minute(number)

This function is deprecated. Use `minute/0` or `minutes/1` instead..

Specs

minute(integer()) :: t()

minutes(number)

Specs

minutes(integer()) :: t()

Returns given amount of minutes in Membrane.Time units.

monotonic_time()

Specs

monotonic_time() :: t()

Returns current monotonic time based on System.monotonic_time/0 in Membrane.Time units.

nanosecond()

Specs

nanosecond() :: t()

Returns one nanosecond in Membrane.Time units.

nanosecond(number)

This function is deprecated. Use `nanosecond/0` or `nanoseconds/1` instead..

Specs

nanosecond(integer()) :: t()

nanoseconds(number)

Specs

nanoseconds(integer()) :: t()

Returns given amount of nanoseconds in Membrane.Time units.

native_unit()

Specs

native_unit() :: t()

Returns one VM native unit in Membrane.Time units.

native_unit(number)

This function is deprecated. Use `native_unit/0` or `native_units/1` instead..

Specs

native_unit(integer()) :: t()

native_units(number)

Specs

native_units(integer()) :: t()

Returns given amount of VM native units in Membrane.Time units.

os_time()

Specs

os_time() :: t()

Returns current POSIX time of operating system based on System.os_time/0 in Membrane.Time units.

This time is not monotonic.

pretty_duration(time)

Specs

pretty_duration(t()) :: String.t()

Returns duration as a string with unit. Chosen unit is the biggest possible that doesn't involve precission loss.

Examples

iex> import Membrane.Time
iex> 10 |> milliseconds() |> pretty_duration()
"10 ms"
iex> 60_000_000 |> microseconds() |> pretty_duration()
"1 min"
iex> 2 |> nanoseconds() |> pretty_duration()
"2 ns"

pretty_now()

Specs

pretty_now() :: String.t()

Returns current time in pretty format (currently iso8601), as string Uses system_time/0 under the hood.

second()

Specs

second() :: t()

Returns one second in Membrane.Time units.

second(number)

This function is deprecated. Use `second/0` or `seconds/1` instead..

Specs

second(integer()) :: t()

seconds(number)

Specs

seconds(integer()) :: t()

Returns given amount of seconds in Membrane.Time units.

system_time()

This function is deprecated. Use os_time/0 or vm_time/0 instead.

Specs

system_time() :: t()

Returns current time of Erlang VM based on System.system_time/0 in Membrane.Time units.

to_code(time)

Specs

to_code(t()) :: Macro.t()

Returns quoted code producing given amount time. Chosen unit is the biggest possible that doesn't involve precission loss.

Examples

iex> import Membrane.Time
iex> 10 |> milliseconds() |> to_code() |> Macro.to_string()
quote do 10 |> Membrane.Time.milliseconds() end |> Macro.to_string()
iex> 60_000_000 |> microseconds() |> to_code() |> Macro.to_string()
quote do Membrane.Time.minute() end |> Macro.to_string()
iex> 2 |> nanoseconds() |> to_code() |> Macro.to_string()
quote do 2 |> Membrane.Time.nanoseconds() end |> Macro.to_string()

to_code_str(time)

Specs

to_code_str(t()) :: Macro.t()

Returns string representation of result of to_code/1.

to_datetime(value)

Specs

to_datetime(t()) :: DateTime.t()

Returns time as a DateTime struct. TimeZone is set to UTC.

to_days(time)

Specs

to_days(t()) :: integer()

Returns time in days. Rounded using Kernel.round/1.

to_hours(time)

Specs

to_hours(t()) :: integer()

Returns time in hours. Rounded using Kernel.round/1.

to_iso8601(value)

Specs

to_iso8601(t()) :: String.t()

Returns time as a iso8601 string.

to_microseconds(time)

Specs

to_microseconds(t()) :: integer()

Returns time in microseconds. Rounded using Kernel.round/1.

to_milliseconds(time)

Specs

to_milliseconds(t()) :: integer()

Returns time in milliseconds. Rounded using Kernel.round/1.

to_minutes(time)

Specs

to_minutes(t()) :: integer()

Returns time in minutes. Rounded using Kernel.round/1.

to_nanoseconds(time)

Specs

to_nanoseconds(t()) :: integer()

Returns time in nanoseconds. Rounded using Kernel.round/1.

to_native_units(value)

Specs

to_native_units(t()) :: integer()

Returns time in VM native units. Rounded using Kernel.round/1.

to_ntp_timestamp(timestamp)

Specs

to_ntp_timestamp(timestamp :: t()) :: <<_::64>>

Converts the timestamp into NTP timestamp. May introduce small rounding errors.

to_seconds(time)

Specs

to_seconds(t()) :: integer()

Returns time in seconds. Rounded using Kernel.round/1.

vm_time()

Specs

vm_time() :: t()

Returns current Erlang VM system time based on System.system_time/0 in Membrane.Time units.

It is the VM view of the os_time/0. They may not match in case of time warps. It is not monotonic.