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: StringName of the assay.
assay_spec: Vec<Region>Ordered list of top-level regions defining the assay structure.
Implementations§
Source§impl Assay
impl Assay
Sourcepub fn new(
name: String,
assay_spec: Vec<Region>,
) -> Result<Self, Box<dyn Error>>
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.
Sourcepub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn Error>>
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.
Sourcepub fn forward_bounds(&self, region_id: &str) -> Option<(usize, usize)>
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.
Sourcepub fn reverse_bounds(&self, region_id: &str) -> Option<(usize, usize)>
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.
Sourcepub fn region_sequence(&self, region_id: &str) -> Option<&str>
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.
Sourcepub fn region_sequences_by_type(&self, region_type: RegionType) -> Vec<&str>
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<'de> Deserialize<'de> for Assay
impl<'de> Deserialize<'de> for Assay
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
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
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.