Skip to main content

Assay

Struct Assay 

Source
pub struct Assay {
    pub name: String,
    pub assay_spec: Vec<Region>,
    /* private fields */
}
Expand description

A parsed assay design: a name and an ordered list of top-level regions.

Fields§

§name: String

Name of the assay.

§assay_spec: Vec<Region>

Ordered list of top-level regions defining the assay structure.

Implementations§

Source§

impl Assay

Source

pub fn new( name: String, assay_spec: Vec<Region>, ) -> Result<Self, Box<dyn Error>>

Builds an assay from a name and region tree already in memory.

Validates the region tree and precomputes slice bounds.

§Errors

Returns an error if the assay is structurally invalid: a duplicate region_id, a missing required region, or a leaf region without a min_len.

Source

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn Error>>

Loads and validates an assay from a YAML file at path.

§Errors

Returns an error if the file cannot be read, the YAML cannot be deserialized, or the assay is structurally invalid: a duplicate region_id, a missing required region, or a leaf region without a min_len.

Source

pub fn forward_bounds(&self, region_id: &str) -> Option<(usize, usize)>

Forward slice bounds (s, e) so that read[s..e] extracts the region from a forward-oriented assay read. Returns None if region_id is unknown.

Source

pub fn reverse_bounds(&self, region_id: &str) -> Option<(usize, usize)>

Reverse slice bounds (s, e) so that read[s..e] extracts the region directly from the raw (non-reverse-complemented) reverse read. The read is sequenced from the amplicon 3’ end, so these bounds index from the start of that read and are independent of read length. Returns None if region_id is unknown.

Source

pub fn region_sequence(&self, region_id: &str) -> Option<&str>

Returns the YAML sequence string for region_id, searching the nested region tree. Returns None if the id is unknown or the region has no sequence.

Source

pub fn region_sequences_by_type(&self, region_type: RegionType) -> Vec<&str>

Returns the YAML sequence strings for every region of type region_type, searching the nested region tree in document order.

Panics if a matching region has no sequence.

Trait Implementations§

Source§

impl Clone for Assay

Source§

fn clone(&self) -> Assay

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Assay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Assay

Source§

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

§

impl Freeze for Assay

§

impl RefUnwindSafe for Assay

§

impl Send for Assay

§

impl Sync for Assay

§

impl Unpin for Assay

§

impl UnsafeUnpin for Assay

§

impl UnwindSafe for Assay

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V