API Reference VCF v1.0.0

Parse, validate, stream, transform, and write Variant Call Format files.

Incremental physical-line decoding for plain, gzip, and BGZF byte streams.

A fully collected VCF header, records, and warnings.

Machine-readable error produced while parsing, validating, or writing VCF.

An ordered INFO or sample FORMAT field.

A typed INFO or FORMAT declaration from a VCF header.

A typed VCF genotype with arbitrary ploidy and per-allele phasing.

A parsed VCF header with ordered metadata and sample names.

An ordered VCF header metadata entry.

Exception raised by bang APIs when VCF input cannot be parsed.

A typed VCF data record.

Ordered FORMAT values for one VCF sample.

A VCF input source with explicit ownership and repeatability semantics.

Version-profile selection for the supported VCF specifications.

Validation profile for VCF 4.1.

Validation profile for VCF 4.2.

Validation profile for VCF 4.3.

Validation profile for VCF 4.4.

Validation profile for VCF 4.5.

A header-aware lazy record stream.

Validates typed headers and records against their declared VCF version.

Validates fixed and context-dependent VCF Number cardinalities.

A supported Variant Call Format specification version.

Machine-readable warning retained when permissive parsing recovers.

Canonical VCF encoding and output destinations.