Struct noodles::csi::index::reference_sequence::Metadata [−][src]
pub struct Metadata { /* fields omitted */ }
Expand description
Index reference sequence metadata.
Implementations
pub fn new(
start_position: VirtualPosition,
end_position: VirtualPosition,
mapped_record_count: u64,
unmapped_record_count: u64
) -> Metadata
pub fn new(
start_position: VirtualPosition,
end_position: VirtualPosition,
mapped_record_count: u64,
unmapped_record_count: u64
) -> Metadata
Creates reference sequence metadata.
Examples
use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::Metadata;
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
Returns the start virtual position.
Examples
use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::Metadata;
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
assert_eq!(metadata.start_position(), bgzf::VirtualPosition::from(610));
Returns the end virtual position.
Examples
use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::Metadata;
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
assert_eq!(metadata.end_position(), bgzf::VirtualPosition::from(1597));
Returns the number of mapped records.
Examples
use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::Metadata;
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
assert_eq!(metadata.mapped_record_count(), 55);
Returns the number of unmapped records.
Examples
use noodles_bgzf as bgzf;
use noodles_csi::index::reference_sequence::Metadata;
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
assert_eq!(metadata.unmapped_record_count(), 0);
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Metadata
impl UnwindSafe for Metadata
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.