Struct noodles_cram::crai::record::Record

source · [−]

pub struct Record { /* private fields */ }

Expand description

A CRAM index record.

Implementations

source

impl Record

source

pub fn new(
 reference_sequence_id: Option<ReferenceSequenceId>,
 alignment_start: i32,
 alignment_span: i32,
 offset: u64,
 landmark: u64,
 slice_length: u64
) -> Self

Creates a CRAM index record.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

source

pub fn reference_sequence_id(&self) -> Option<ReferenceSequenceId>

Returns the reference sequence ID.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.reference_sequence_id().map(i32::from), Some(0));

source

pub fn alignment_start(&self) -> i32

Returns the alignment start.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.alignment_start(), 10946);

source

pub fn alignment_span(&self) -> i32

Returns the alignment span.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.alignment_span(), 6765);

source

pub fn offset(&self) -> u64

Returns the offset of the container from the start of the stream.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.offset(), 17711);

source

pub fn landmark(&self) -> u64

Returns the offset of the slice from the start of the container.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.landmark(), 233);

source

pub fn slice_length(&self) -> u64

Returns the size of the slice in bytes.

Examples

use noodles_bam as bam;
use noodles_cram::crai;

let record = crai::Record::new(
    bam::record::ReferenceSequenceId::try_from(0).map(Some)?,
    10946,
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.slice_length(), 317811);