Struct noodles_sam::alignment::record_buf::data::Data

source ·

pub struct Data(/* private fields */);

Expand description

An alignment record data buffer.

Implementations§

source §

impl Data

source

pub fn len(&self) -> usize

Returns the number of fields.

§Examples

use noodles_sam::alignment::record_buf::Data;
let data = Data::default();
assert_eq!(data.len(), 0);

source

pub fn is_empty(&self) -> bool

Returns whether there are any fields.

§Examples

use noodles_sam::alignment::record_buf::Data;
let data = Data::default();
assert!(data.is_empty());

source

pub fn clear(&mut self)

Removes all fields from the map.

This does not affect the internal capacity.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let nh = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let mut data: Data = [nh].into_iter().collect();
assert_eq!(data.len(), 1);
data.clear();
assert!(data.is_empty());

source

pub fn get<K>(&self, tag: &K) -> Option<&Value>
where K: Equivalent<Tag>,

Returns a reference to the value of the given tag.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let (tag, value) = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let data: Data = [(tag, value.clone())].into_iter().collect();

assert_eq!(data.get(&tag), Some(&value));
assert!(data.get(&Tag::READ_GROUP).is_none());

source

pub fn get_mut<K>(&mut self, tag: &K) -> Option<&mut Value>
where K: Equivalent<Tag>,

Returns a mutable reference to the value of the given tag.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let tag = Tag::ALIGNMENT_HIT_COUNT;
let mut data: Data = [(tag, Value::from(1))].into_iter().collect();

if let Some(v) = data.get_mut(&tag) {
    *v = Value::from(2);
}

assert_eq!(data.get(&tag), Some(&Value::from(2)));

source

pub fn get_index_of<K>(&self, tag: &K) -> Option<usize>
where K: Equivalent<Tag>,

Returns the index of the field of the given tag.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let nh = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let data: Data = [nh].into_iter().collect();

assert_eq!(data.get_index_of(&Tag::ALIGNMENT_HIT_COUNT), Some(0));
assert!(data.get_index_of(&Tag::READ_GROUP).is_none());

source

pub fn iter(&self) -> impl Iterator<Item = (Tag, &Value)>

Returns an iterator over all tag-value pairs.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let (tag, value) = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let data: Data = [(tag, value.clone())].into_iter().collect();

let mut fields = data.iter();
assert_eq!(fields.next(), Some((tag, &value)));
assert!(fields.next().is_none());

source

pub fn keys(&self) -> impl Iterator<Item = Tag> + '_

Returns an iterator over all tags.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let nh = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let data: Data = [nh].into_iter().collect();

let mut keys = data.keys();
assert_eq!(keys.next(), Some(Tag::ALIGNMENT_HIT_COUNT));
assert!(keys.next().is_none());

source

pub fn values(&self) -> impl Iterator<Item = &Value>

Returns an iterator over all values.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let (tag, value) = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let data: Data = [(tag, value.clone())].into_iter().collect();

let mut values = data.values();
assert_eq!(values.next(), Some(&value));
assert!(values.next().is_none());

source

pub fn insert(&mut self, tag: Tag, value: Value) -> Option<(Tag, Value)>

Inserts a field into the map.

This uses the field tag as the key and field as the value.

If the tag already exists in the map, the existing field is replaced by the new one, and the existing field is returned.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let mut data = Data::default();
data.insert(Tag::ALIGNMENT_HIT_COUNT, Value::from(1));

source

pub fn remove<K>(&mut self, tag: &K) -> Option<(Tag, Value)>
where K: Equivalent<Tag>,

Removes the field with the given tag.

The field is returned if it exists.

This works like Vec::swap_remove; it does not preserve the order but has a constant time complexity.

§Examples

use noodles_sam::alignment::{
    record::data::field::Tag,
    record_buf::{data::field::Value, Data},
};

let nh = (Tag::ALIGNMENT_HIT_COUNT, Value::from(1));
let rg = (Tag::READ_GROUP, Value::from("rg0"));
let md = (Tag::ALIGNMENT_SCORE, Value::from(98));
let mut data: Data = [nh.clone(), rg.clone(), md.clone()].into_iter().collect();

assert_eq!(data.remove(&Tag::ALIGNMENT_HIT_COUNT), Some(nh));
assert!(data.remove(&Tag::COMMENT).is_none());

let expected = [md, rg].into_iter().collect();
assert_eq!(data, expected);