noodles_gff/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#![warn(missing_docs)]

//! **noodles-gff** handles the reading and writing of the [GFF3 format][gff3-spec].
//!
//! GFF (Generic Feature Format) is a text-based format used to represent genomic features.
//!
//! [gff3-spec]: https://github.com/The-Sequence-Ontology/Specifications/blob/be6e1af7243ba4235c30b69660e2669e444e2f3e/gff3.md
//!
//! # Examples
//!
//! ## Read all records in a GFF3 file
//!
//! ```no_run
//! # use std::{fs::File, io::{self, BufReader}};
//! use noodles_gff as gff;
//!
//! let mut reader = File::open("annotations.gff3")
//!     .map(BufReader::new)
//!     .map(gff::io::Reader::new)?;
//!
//! for result in reader.records() {
//!     let record = result?;
//!
//!     println!(
//!         "{}\t{}\t{}",
//!         record.reference_sequence_name(),
//!         record.start(),
//!         record.end(),
//!     );
//! }
//! # Ok::<(), io::Error>(())
//! ```

#[cfg(feature = "async")]
pub mod r#async;

pub mod directive;
pub mod io;
pub mod lazy;
pub mod line;
pub mod record;

pub use self::{directive::Directive, line::Line, record::Record};

#[deprecated(since = "0.33.0", note = "Use `noodles_gff::io::Reader` instead.")]
pub use self::io::Reader;

#[deprecated(since = "0.33.0", note = "Use `noodles_gff::io::Writer` instead.")]
pub use self::io::Writer;

#[cfg(feature = "async")]
pub use self::r#async::io::Reader as AsyncReader;