Struct MotifHit 

pub struct MotifHit { /* private fields */ }

A motif hit with optional sequence or genomic location.

Implementations

impl MotifHit

pub const fn new( name: MotifName, pattern: MotifPattern, kind: MotifKind, ) -> MotifHit

Creates motif hit metadata with no location.

pub fn with_genomic_range(self, range: GenomicRange) -> MotifHit

Sets the optional genomic range.

pub fn with_sequence_range( self, start: usize, end: usize, ) -> Result<MotifHit, MotifValueError>

Sets the optional sequence range.

Errors

Returns MotifValueError::SequenceRangeEndBeforeStart when end < start.

pub const fn name(&self) -> &MotifName

Returns the motif name.

pub const fn pattern(&self) -> &MotifPattern

Returns the motif pattern.

pub const fn kind(&self) -> &MotifKind

Returns the motif kind.

pub const fn genomic_range(&self) -> Option<&GenomicRange>

Returns the optional genomic range.

pub const fn sequence_range(&self) -> Option<(usize, usize)>

Returns the optional sequence range as (start, end).

Trait Implementations

impl Clone for MotifHit

fn clone(&self) -> MotifHit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MotifHit

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

Formats the value using the given formatter.

impl PartialEq for MotifHit

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

impl StructuralPartialEq for MotifHit