DBF.Field (dbf_ex v0.4.0)

Copy Markdown

Metadata describing a field in a DBF record.

Summary

Types

binary_decoder()

@type binary_decoder() :: :integer | :currency | :datetime | :text_memo | :varbinary

decoder()

@type decoder() ::
  {:text, text_decoder()}
  | {:binary, binary_decoder()}
  | {:unsupported, binary()}

t()

@type t() :: %DBF.Field{
  address: non_neg_integer() | nil,
  autoincrement_next: non_neg_integer() | nil,
  autoincrement_step: byte() | nil,
  decimal: non_neg_integer() | nil,
  decoder: decoder(),
  descriptor_offset: non_neg_integer(),
  flags: byte() | nil,
  length: non_neg_integer(),
  name: binary(),
  null_bit: non_neg_integer() | nil,
  raw_descriptor: binary(),
  record_offset: pos_integer(),
  reserved: binary(),
  set_fields_flag: byte() | nil,
  type: binary(),
  variable_length_bit: non_neg_integer() | nil,
  work_area: byte() | nil
}

text_decoder()

@type text_decoder() ::
  :character
  | :float
  | :logical
  | {:numeric, DBF.numeric_policy() | :exact_unscaled}
  | :varchar
  | :memo
  | :date