Struct noodles_cram::crai::record::Record

source · [−]

pub struct Record { /* private fields */ }

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Record

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

Formats the value using the given formatter. Read more

impl Default for Record

fn default() -> Record

Returns the “default value” for a type. Read more

impl Display for Record

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

Formats the value using the given formatter. Read more

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. Read more

impl PartialEq<Record> for Record

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

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

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

This method tests for !=.

impl Eq for Record

impl StructuralEq for Record

impl StructuralPartialEq for Record

Auto Trait Implementations

impl RefUnwindSafe for Record

impl Send for Record

impl Sync for Record

impl Unpin for Record

impl UnwindSafe for Record

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.