Struct GenomeBuild 

pub struct GenomeBuild { /* private fields */ }

Genome build includes the contigs and the genome build metadata.

Implementations

impl GenomeBuild

pub fn new<I>(id: GenomeBuildIdentifier, contigs: I) -> Self

where I: IntoIterator<Item = Contig>,

pub fn id(&self) -> &GenomeBuildIdentifier

Get the genome build identifiers.

pub fn contigs(&self) -> impl Iterator<Item = &Contig>

Get an iterator with all contigs.

pub fn contig_by_name(&self, name: &str) -> Option<&Contig>

Retrieve a Contig by its name or None if no such Contig can be found.

Examples

use dabuild::{GenomeBuild, GenomeBuildIdentifier};
use dabuild::builds::get_grch38_p13;

let build: GenomeBuild = get_grch38_p13();

// Query by a contig name ...
let chrY = build.contig_by_name("Y").unwrap();
assert_eq!(chrY.name(), "Y");

// ... or by GenBank accession ...
let chrY = build.contig_by_name("CM000686.2").unwrap();
assert_eq!(chrY.genbank_name(), Some("CM000686.2"));

// ... or by RefSeq accession ...
let chrY = build.contig_by_name("NC_000024.10").unwrap();
assert_eq!(chrY.refseq_name(), Some("NC_000024.10"));

// ... or by UCSC accession.
let chrY = build.contig_by_name("chrY").unwrap();
assert_eq!(chrY.ucsc_name(), Some("chrY"));

Trait Implementations

impl Clone for GenomeBuild

fn clone(&self) -> GenomeBuild

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GenomeBuild

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GenomeBuild

fn eq(&self, other: &GenomeBuild) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GenomeBuild

impl StructuralPartialEq for GenomeBuild