Struct bed_utils::bed::BED

pub struct BED<const N: u8> {
    pub name: Option<String>,
    pub score: Option<Score>,
    pub strand: Option<Strand>,
    pub optional_fields: OptionalFields,
    /* private fields */
}

A standard BED record.

Fields

name: Option<String>

score: Option<Score>

strand: Option<Strand>

optional_fields: OptionalFields

Implementations

impl<const N: u8> BED<N>

pub fn new<C>( chrom: C, start: u64, end: u64, name: Option<String>, score: Option<Score>, strand: Option<Strand>, optional_fields: OptionalFields ) -> Self

where C: Into<String>,

Trait Implementations

impl<const N: u8> BEDLike for BED<N>

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<const N: u8> Clone for BED<N>

fn clone(&self) -> BED<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: u8> Debug for BED<N>

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

Formats the value using the given formatter.

impl<'de, const N: u8> Deserialize<'de> for BED<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: u8> Display for BED<N>

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

Formats the value using the given formatter.

impl<const N: u8> FromStr for BED<N>

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<const N: u8> PartialEq for BED<N>

fn eq(&self, other: &BED<N>) -> 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<const N: u8> Serialize for BED<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: u8> Eq for BED<N>

impl<const N: u8> StructuralPartialEq for BED<N>