Struct Record

pub struct Record { /* private fields */ }

A CRAM index record.

Implementations

impl Record

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

Creates a CRAM index record.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

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

Returns the reference sequence ID.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.reference_sequence_id(), Some(0));

pub fn alignment_start(&self) -> Option<Position>

Returns the alignment start.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

assert_eq!(record.alignment_start(), Position::new(10946));

pub fn alignment_span(&self) -> usize

Returns the alignment span.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

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

pub fn offset(&self) -> u64

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

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

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

pub fn landmark(&self) -> u64

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

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

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

pub fn slice_length(&self) -> u64

Returns the size of the slice in bytes.

Examples

use noodles_core::Position;
use noodles_cram::crai;

let record = crai::Record::new(
    Some(0),
    Position::new(10946),
    6765,
    17711,
    233,
    317811,
);

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

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Default for Record

fn default() -> Record

Returns the “default value” for a type.

impl Display for Record

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

Formats the value using the given formatter.

impl FromStr for Record

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Record

fn eq(&self, other: &Record) -> 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 Record

impl StructuralPartialEq for Record