Struct noodles::csi::index::reference_sequence::Metadata

pub struct Metadata { /* fields omitted */ }

Index reference sequence metadata.

Implementations

impl 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,
);

pub fn start_position(&self) -> VirtualPosition

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));

pub fn end_position(&self) -> VirtualPosition

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));

pub fn mapped_record_count(&self) -> u64

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);

pub fn unmapped_record_count(&self) -> u64

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

impl Clone for Metadata

pub fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq<Metadata> for Metadata

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Metadata

impl StructuralEq for Metadata

impl StructuralPartialEq for Metadata