Skip to main content

YaraRecord

Struct YaraRecord 

Source
pub struct YaraRecord {
Show 19 fields pub read_pair_index: u32, pub is_read1: bool, pub contig_id: u32, pub pos: u32, pub is_reverse: bool, pub is_secondary: bool, pub is_unmapped: bool, pub mapq: u8, pub nm: u8, pub x0: u16, pub x1: u16, pub mate_contig_id: u32, pub mate_pos: u32, pub tlen: i32, pub flag: u16, pub cigar: Vec<CigarOp>, pub seq: Option<Vec<u8>>, pub qual: Option<Vec<u8>>, pub xa: Option<String>,
}
Expand description

A single alignment record returned by the YARA mapper.

This is a fully-owned Rust type — all heap data (CIGAR, sequence, quality, XA tag) has been copied from the C++ side and the C++ memory freed.

Fields§

§read_pair_index: u32

Index of the read pair in the input batch (0-based).

§is_read1: bool

Whether this record is for the first read in the pair.

§contig_id: u32

Reference contig index.

§pos: u32

0-based leftmost position on the reference.

§is_reverse: bool

Whether the read is mapped to the reverse strand.

§is_secondary: bool

Whether this is a secondary alignment.

§is_unmapped: bool

Whether the read is unmapped.

§mapq: u8

Mapping quality.

§nm: u8

Edit distance (NM tag).

§x0: u16

Number of co-optimal alignments (X0 tag).

§x1: u16

Number of sub-optimal alignments (X1 tag).

§mate_contig_id: u32

Mate’s reference contig index.

§mate_pos: u32

Mate’s 0-based position.

§tlen: i32

Template length (TLEN).

§flag: u16

Full SAM flag field.

§cigar: Vec<CigarOp>

CIGAR operations (empty for secondaries without align_secondary).

§seq: Option<Vec<u8>>

Read sequence (None for secondary records).

§qual: Option<Vec<u8>>

Base qualities (None for secondary records).

§xa: Option<String>

XA tag string (only when secondary_mode=Tag, otherwise None).

Implementations§

Source§

impl YaraRecord

Source

pub fn cigar_string(&self) -> String

CIGAR string in SAM format (e.g., “50M2I48M”).

Trait Implementations§

Source§

impl Clone for YaraRecord

Source§

fn clone(&self) -> YaraRecord

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for YaraRecord

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.