Struct bed_utils::bed::GenomicRange

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

A minimal BED record with only 3 fields.

Implementations

impl GenomicRange

pub fn new<C>(chrom: C, start: u64, end: u64) -> Self

where C: Into<String>,

pub fn pretty_show(&self) -> String

Convert the record to a string representation: chr:start-end

Trait Implementations

impl BEDLike for GenomicRange

fn chrom(&self) -> &str

Return the chromosome name of the record

fn set_chrom(&mut self, chrom: &str) -> &mut Self

Change the chromosome name of the record

fn start(&self) -> u64

Return the 0-based start position of the record

fn set_start(&mut self, start: u64) -> &mut Self

Change the 0-based start position of the record

fn end(&self) -> u64

Return the end position (non-inclusive) of the record

fn set_end(&mut self, end: u64) -> &mut Self

Change the end position (non-inclusive) of the record

fn name(&self) -> Option<&str>

Return the name of the record

fn score(&self) -> Option<Score>

Return the score of the record

fn strand(&self) -> Option<Strand>

Return the strand of the record

fn len(&self) -> u64

Return the length of the record. Return 0 if the end position is smaller than the start position.

fn compare(&self, other: &Self) -> Ordering

fn overlap<B: BEDLike>(&self, other: &B) -> Option<GenomicRange>

Return the overlap

fn n_overlap<B: BEDLike>(&self, other: &B) -> u64

Return the size of overlap between two records

fn to_genomic_range(&self) -> GenomicRange

Convert the record to a GenomicRange

impl Clone for GenomicRange

fn clone(&self) -> GenomicRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenomicRange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenomicRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GenomicRange

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

Formats the value using the given formatter.

impl FromStr for GenomicRange

Convert string to GenomicRange. ‘\t’, ‘:’, and ‘-’ are all considered as valid delimiters. So any of the following formats is valid:

• chr1\t100\t200
• chr1:100-200

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GenomicRange

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GenomicRange

fn cmp(&self, other: &GenomicRange) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for GenomicRange

fn eq(&self, other: &GenomicRange) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GenomicRange

fn partial_cmp(&self, other: &GenomicRange) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GenomicRange

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sortable for GenomicRange

fn encode<W: Write>(&self, writer: &mut W)

fn decode<R: Read>(reader: &mut R) -> Option<Self>

impl Eq for GenomicRange

impl StructuralPartialEq for GenomicRange