pregao v0.1.0 Pregao.Bdi

A struct that contains information parsed from a BDI file.

It contains the following fields:

  • :header - a Pregao.Bdi.Header struct containing general information about the BDI file
  • :indexes - a list of Pregao.Bdi.IndexSummary structs for all indexes found on the BDI file

Summary

Functions

Parses a Pregao.Bdi struct from a BDI file

Types

t()
t :: %Pregao.Bdi{header: Pregao.Bdi.Header, indexes: [Pregao.Bdi.IndexSummary]}

Functions

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

Parses a Pregao.Bdi struct from a BDI file.

Examples:

iex> Pregao.Bdi.parse(“./test/fixtures/bdi0930”) …> |> Map.get(:header) %Pregao.Bdi.Header{generated_at: ~N[2016-09-30 18:07:00], source: “BOVESPA”, trading_date: ~D[2016-09-30]}

iex> Pregao.Bdi.parse(“./test/fixtures/bdi0930”) …> |> Map.get(:indexes) …> |> Enum.count() 23

iex> Pregao.Bdi.parse(“./test/fixtures/bdi0930”) …> |> Map.get(:indexes) …> |> Enum.at(10) …> |> Map.get(:name) “MIDLARGE CAP”