Estructura.Nested.Type.Time (estructura v1.9.0)

View Source

Estructura type implementation for handling Time values.

This type provides functionality for:

  • Generating Time values for testing
  • Coercing various inputs into Time format
  • Validating Time values

Examples

iex> alias Estructura.Nested.Type.Time
iex> Time.validate(~T[10:00:00])
{:ok, ~T[10:00:00]}

iex> alias Estructura.Nested.Type.Time
iex> Time.validate("not a time")
{:error, "Expected time, got: \"not a time\""}

The type implements the Estructura.Nested.Type behaviour, providing:

  • generate/1 - Creates random Time values for property testing
  • coerce/1 - Attempts to convert input into a Time
  • validate/1 - Ensures a value is a valid Time

Summary

Functions

coerce(term)

Attempts to coerce a value into a Time.

generate(opts \\ [])

Generates random Time values for property-based testing.

validate(term)

Validates that a term is a valid Time.

Functions

coerce(term)

Attempts to coerce a value into a Time.

Delegates to Estructura.Coercers.Time.coerce/1 which handles various input formats including strings in ISO 8601 format and maps with time components.

Examples

iex> Time.coerce("10:00:00")
{:ok, ~T[10:00:00]}

iex> Time.coerce(%{hour: 10, minute: 0, second: 0})
{:ok, ~T[10:00:00]}

iex> Time.coerce("invalid")
{:error, "Invalid Time format"}

generate(opts \\ [])

Generates random Time values for property-based testing.

Options

Accepts all options supported by Estructura.StreamData.time/1.

Examples

iex> Time.generate() |> Enum.take(1) |> List.first()
#Time<...>

iex> Time.generate(from: ~T[09:00:00], to: ~T[17:00:00]) |> Enum.take(1) |> List.first()
#Time<...>

validate(term)

Validates that a term is a valid Time.

Returns {:ok, time} for valid Time values, or {:error, reason} for invalid ones.

Examples

iex> Time.validate(~T[10:00:00])
{:ok, ~T[10:00:00]}

iex> Time.validate("10:00")
{:error, "Expected time, got: \"10:00\""}