Exoffice

v0.3.2

Exoffice v0.3.2 Exoffice.Parser behaviour

Module which provides common interface for parsing office files.

Link to this section Summary

Callbacks

close(pid)

Close opened pid (file or worksheet)

count_rows(pid)

Count rows by pid

extensions()

Returns a list of supported extensions by parser

get_rows(pid)

Returns a stream with rows

parse(arg0, atom)

Function to parse file by path. May return tuple with result or list of tuples if excel file has multiple worksheets

parse_sheet(arg0, atom, atom)

Function to parse file by path and given sheet index Returns result with pid or error with reason

Link to this section Callbacks

Link to this callback close(pid) 
close(pid()) :: :ok

Close opened pid (file or worksheet)

Link to this callback count_rows(pid) 
count_rows(pid()) :: integer()

Count rows by pid

Link to this callback extensions() 
extensions() :: [String.t()]

Returns a list of supported extensions by parser

Link to this callback get_rows(pid) 
get_rows(pid()) :: Stream

Returns a stream with rows

Link to this callback parse(arg0, atom) 
parse(String.t(), Keyword) :: [ok: pid(), error: String.t()]

Function to parse file by path. May return tuple with result or list of tuples if excel file has multiple worksheets

Link to this callback parse_sheet(arg0, atom, atom) 
parse_sheet(String.t(), Integer, Keyword) ::
  {:ok, pid()} | {:error, String.t()}

Function to parse file by path and given sheet index Returns result with pid or error with reason