noodles_vcf/
lib.rs

1//! **noodles-vcf** handles the reading and writing of the VCF format.
2//!
3//! # Examples
4//!
5//! ## Read all records from a file
6//!
7//! ```no_run
8//! use noodles_vcf as vcf;
9//!
10//! let mut reader = vcf::io::reader::Builder::default().build_from_path("sample.vcf")?;
11//! let header = reader.read_header()?;
12//!
13//! for result in reader.records() {
14//!     let record = result?;
15//!     // ...
16//! }
17//! # Ok::<_, std::io::Error>(())
18//! ```
19
20#[cfg(feature = "async")]
21pub mod r#async;
22
23pub mod fs;
24pub mod header;
25pub mod io;
26pub mod record;
27pub mod variant;
28
29pub use self::{header::Header, record::Record};
30
31#[cfg(feature = "async")]
32#[deprecated(since = "0.79.0", note = "Use `vcf::r#async::io::Reader` instead.")]
33pub use self::r#async::io::Reader as AsyncReader;
34
35#[cfg(feature = "async")]
36#[deprecated(since = "0.79.0", note = "Use `vcf::r#async::io::Writer` instead.")]
37pub use self::r#async::io::Writer as AsyncWriter;