pregao v0.1.0 Pregao.Bdi.Header

A struct that provides general information about the BDI file.

It contains the following fields:

  • :source - the source of the file (this is always “BOVESPA”, apparently)
  • :generated_at - the date and time at which the file was generated
  • :trading_date - the trading date for which this file contains information

Summary

Functions

Parses a Pregao.Bdi.Header struct from a raw string

Types

t()
t :: %Pregao.Bdi.Header{generated_at: NaiveDateTime, source: String, trading_date: Date}

Functions

parse(arg)
parse(String.t) :: Pregao.Bdi.Header

Parses a Pregao.Bdi.Header struct from a raw string.

Examples:

# Parses the header from the first line of the BDI file iex> File.stream!(“./test/fixtures/bdi0930”) …> |> Enum.at(0) …> |> Pregao.Bdi.Header.parse() %Pregao.Bdi.Header{generated_at: ~N[2016-09-30 18:07:00], source: “BOVESPA”, trading_date: ~D[2016-09-30]}