Struct BaseModifications

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

Base modifications.

Implementations

impl BaseModifications

pub fn parse( s: &str, is_reverse_complemented: bool, sequence: &Sequence, ) -> Result<Self, ParseError>

Parses base modifications from a string.

Examples

use noodles_sam::{
    alignment::record_buf::Sequence,
    record::data::field::value::{
        base_modifications::{
            group::{modification, Strand, UnmodifiedBase},
            Group,
        },
        BaseModifications,
    },
};

let is_reverse_complemented = false;
let sequence = Sequence::from(b"CACCCGATGACCGGCT");
let base_modifications = BaseModifications::parse(
    "C+m,1,3,0;",
    is_reverse_complemented,
    &sequence,
)?;

assert_eq!(base_modifications, BaseModifications::from(vec![
    Group::new(
        UnmodifiedBase::C,
        Strand::Forward,
        vec![modification::FIVE_METHYLCYTOSINE],
        None,
        vec![2, 11, 14],
    )
]));

Trait Implementations

impl AsMut<Vec<Group>> for BaseModifications

fn as_mut(&mut self) -> &mut Vec<Group>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[Group]> for BaseModifications

fn as_ref(&self) -> &[Group]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BaseModifications

fn clone(&self) -> BaseModifications

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaseModifications

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

Formats the value using the given formatter.

impl From<BaseModifications> for Vec<Group>

fn from(base_modifications: BaseModifications) -> Self

Converts to this type from the input type.

impl From<Vec<Group>> for BaseModifications

fn from(groups: Vec<Group>) -> Self

Converts to this type from the input type.

impl PartialEq for BaseModifications

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

impl StructuralPartialEq for BaseModifications