VCF.FieldDefinition (VCF v1.0.0)

A typed INFO or FORMAT declaration from a VCF header.

Summary

Types

cardinality()

field_type()

t()

Functions

parse_number(value)

Parses a syntactically recognized VCF Number token.

parse_type(arg1)

Parses a VCF field Type token without dynamically creating atoms.

Types

cardinality()

@type cardinality() ::
  non_neg_integer() | :a | :r | :g | :p | :la | :lr | :lg | :m | :variable

field_type()

@type field_type() :: :integer | :float | :flag | :character | :string

t()

@type t() :: %VCF.FieldDefinition{
  attributes: [{String.t(), String.t()}],
  description: String.t() | nil,
  id: String.t(),
  number: cardinality() | nil,
  type: field_type() | nil
}

Functions

parse_number(value)

@spec parse_number(String.t()) :: {:ok, cardinality()} | :error

Parses a syntactically recognized VCF Number token.

parse_type(arg1)

@spec parse_type(String.t()) :: {:ok, field_type()} | :error

Parses a VCF field Type token without dynamically creating atoms.