ExRets v0.1.1 ExRets.CompactRecord View Source

Compact records are sequences of fields separated by a delimiter.

Link to this section Summary

Types

Option for decoding compact data.

Options for decoding compact data.

t()

Parsed list of fields.

Functions

Parses a compact record string into a list of strings.

Link to this section Types

Link to this type

decode_opt()

View Source (since 0.1.0)
decode_opt() :: {:delimiter, ExRets.CompactDelimiter.t()}

Option for decoding compact data.

Link to this type

decode_opts()

View Source (since 0.1.0)
decode_opts() :: [decode_opt()]

Options for decoding compact data.

Link to this type

t()

View Source (since 0.1.0)
t() :: [String.t()]

Parsed list of fields.

Link to this section Functions

Link to this function

decode(record, opts \\ [])

View Source (since 0.1.0)
decode(record :: String.t(), decode_opts()) :: [String.t()]

Parses a compact record string into a list of strings.

Options

  • :delimiter - string that separates the compact record fields. Defaults to \t.

Examples

iex> ExRets.CompactRecord.decode("\tListingKey\tModificationTimestamp\t")
["ListingKey", "ModificationTimestamp"]

iex> ExRets.CompactRecord.decode("\nListingKey\nModificationTimestamp\n", delimiter: "\n")
["ListingKey", "ModificationTimestamp"]