Struct noodles_bam::record::data::Data

pub struct Data<'a>(_);

BAM record data.

This is also called optional fields.

Implementations

impl<'a> Data<'a>

pub fn new(bytes: &[u8]) -> Data<'_>

Creates data from raw data data.

Examples

use noodles_bam::record::Data;

let raw_data = [
    b'N', b'H', b'i', 0x01, 0x00, 0x00, 0x00, // NH:i:1
    b'R', b'G', b'Z', b'r', b'g', b'0', 0x00, // RG:Z:rg0
];
let data = Data::new(&raw_data);

pub fn fields(&self) -> Fields<&[u8]>

Returns an iterator over data fields.

Examples

use noodles_bam::record::{data::{field::Value, Field}, Data};
use noodles_sam::record::data::field::Tag;

let raw_data = [
    b'N', b'H', b'i', 0x01, 0x00, 0x00, 0x00, // NH:i:1
    b'R', b'G', b'Z', b'r', b'g', b'0', 0x00, // RG:Z:rg0
];
let data = Data::new(&raw_data);

let mut fields = data.fields();

assert_eq!(
    fields.next().transpose()?,
    Some(Field::new(Tag::AlignmentHitCount, Value::Int32(1)))
);

assert_eq!(
    fields.next().transpose()?,
    Some(Field::new(Tag::ReadGroup, Value::String(String::from("rg0"))))
);

assert!(fields.next().is_none());

Trait Implementations

impl<'a> Debug for Data<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Data<'a>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> TryFrom<Data<'a>> for Data

type Error = TryFromDataError

The type returned in the event of a conversion error.

fn try_from(data: Data<'_>) -> Result<Self, Self::Error>

Performs the conversion.