noodles_vcf/
lib.rs

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

noodles_vcf/
lib.rs
