Struct codenano::Domain

pub struct Domain<Label> {
    pub helix: isize,
    pub start: isize,
    pub end: isize,
    pub forward: bool,
    pub label: Option<Label>,
    pub sequence: Option<Cow<'static, str>>,
}

A domain, i.e. an interval of a helix.

Fields

helix: isize

Index of the helix in the array of helices. Indices start at 0.

start: isize

Position of the leftmost base of this domain along the helix (this might be the first or last base of the domain, depending on the orientation parameter below).

end: isize

Position of the first base after the forwardmost base of the domain, along the helix. Domains must always be such that domain.start < domain.end.

forward: bool

If true, the "5' to 3'" direction of this domain runs in the same direction as the helix, i.e. "to the forward" along the axis of the helix. Else, the 5' to 3' runs to the left along the axis.

label: Option<Label>

An optional label that can be attached to strands.

sequence: Option<Cow<'static, str>>

In addition to the strand-level sequence, individual domains may have sequences too. The precedence has to be defined by the user of this library.

Implementations

impl<Label> Domain<Label>

pub fn iter(&self) -> DomainIter

Iterate through the positions of this domain, in 5' to 3' order (meaning that the values produced by this iterator might be increasing or decreasing).

pub fn translate(self, dx: isize, dy: isize) -> Self

Translate this domain. The first parameter is the translation along the helix, the second one is a translation across helices (probably most meaningful for a flat design).

pub fn shift_x(self, dx: isize) -> Self

Translate this domain along its helix.

pub fn shift_y(self, dy: isize) -> Self

Translate this domain to a different helix (probably most meaningful for a flat design).

pub fn length(&self) -> isize

Number of Nucleotides on the domain

pub fn pseudo_copy(&self) -> Self

Return a domain that has the same bounds as self

pub fn contains(&self, h: isize, x: isize, b: bool) -> bool

Return true iff self contains the nucleotide (h, x, b)

pub fn first_nucl(&self) -> Option<(isize, isize, bool)>

Return the first nucl of self or None if self is empty

pub fn last_nucl(&self) -> Option<(isize, isize, bool)>

Return the last nucl of self or None if self is empty

Trait Implementations

impl<Label: Clone> Clone for Domain<Label>

fn clone(&self) -> Domain<Label>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Label: Debug> Debug for Domain<Label>

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

Formats the value using the given formatter.

impl<Label: Default> Default for Domain<Label>

fn default() -> Domain<Label>

Returns the "default value" for a type.

impl<'de, Label> Deserialize<'de> for Domain<Label> where
    Label: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<Label> Serialize for Domain<Label> where
    Label: Serialize, 

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

Serialize this value into the given Serde serializer.