Exmbus.Parser.DataType.PeriodicDate (Exmbus v0.4.0)

Represents a periodic date data type.

Returned by the parser when decoding a Type G data type with periodicity.

When a component (year, month, or day) is periodic (wildcard), it is represented as nil.

Summary

Types

t()

Functions

new(year, month, day)

Creates a new PeriodicDate struct.

new!(year, month, day)

Creates a new PeriodicDate struct, raising an error on invalid input.

Types

t()

@type t() :: %Exmbus.Parser.DataType.PeriodicDate{
  day: integer() | nil,
  month: integer() | nil,
  year: integer() | nil
}

Functions

new(year, month, day)

@spec new(integer() | nil, integer() | nil, integer() | nil) ::
  {:ok,
   %Exmbus.Parser.DataType.PeriodicDate{
     day: term(),
     month: term(),
     year: term()
   }}

Creates a new PeriodicDate struct.

new!(year, month, day)

@spec new!(integer() | nil, integer() | nil, integer() | nil) ::
  %Exmbus.Parser.DataType.PeriodicDate{
    day: term(),
    month: term(),
    year: term()
  }

@spec new!(any(), any(), any()) :: %Exmbus.Parser.DataType.PeriodicDate{
  day: term(),
  month: term(),
  year: term()
}

Creates a new PeriodicDate struct, raising an error on invalid input.