Enum Error 

#[non_exhaustive]
pub enum Error {
    UnknownAlignState(String),
    InvalidSeqLength(String),
    InvalidAlignLength(String),
    InvalidContigAndStart(String),
    InvalidAlignCoords(String),
    InvalidModCoords(String),
    InvalidModProbs(String),
    InvalidSeq(String),
    InvalidBase(String),
    InvalidReadID(String),
    InvalidModType(String),
    EmptyModType(String),
    RustHtslibError(Error),
    IntConversionError(TryFromIntError),
    StringConversionError(Utf8Error),
    Utf8ConversionError(FromUtf8Error),
    JsonParseError(Error),
    OrdPairConversion(String),
    IntParseError(ParseIntError),
    FloatParseError(ParseFloatError),
    InputOutputError(Error),
    FormattingError(Error),
    CsvError(Error),
    InvalidDuplicates(String),
    InvalidState(String),
    WriteOutput(String),
    NotImplemented(String),
    WrongOrder(String),
    UnavailableData(String),
    Unmapped(String),
    Zero(String),
    ZeroSeqLen(String),
    InvalidRegion {
        region: String,
        pos: u64,
        contig_length: u64,
    },
    InvalidSorting(String),
    WindowDensBelowThres {
        density: F32Bw0and1,
        threshold: F32Bw0and1,
    },
    EmptyWindow(String),
    InsufficientDataSize(String),
    Arithmetic(String),
    BuilderError(UninitializedFieldError),
    BuilderValidation(String),
    FromCharError(TryFromCharError),
    PolarsError(PolarsError),
    SimulateDNASeqCIGAREndProblem(String),
}

Enum that covers errors in our module.

Any error arising from our crate does not have the suffix ‘Error’. If we are deriving an error from an error from another crate, and that has a suffix ‘Error’, we have let it be in our naming of the error.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownAlignState(String)

Alignment of sequence is not known

InvalidSeqLength(String)

Failure upon extracting sequence length

InvalidAlignLength(String)

Failure upon extracting or calculating alignment length of molecule

InvalidContigAndStart(String)

Contig and start of alignment of molecule are invalid

InvalidAlignCoords(String)

Alignment coordinates (contig/start/end) are invalid.

InvalidModCoords(String)

Modification coordinates are invalid

InvalidModProbs(String)

Modification probabilities are invalid

InvalidSeq(String)

Sequence is invalid

InvalidBase(String)

Base is invalid (not A, G, C, T, or N)

InvalidReadID(String)

Read id of molecule is invalid

InvalidModType(String)

Modification type is invalid. Mod types are indicated in mod BAM files like so: …C+m… where C is the base and m is the modification type, in this case methylation.

EmptyModType(String)

Modification type is empty

RustHtslibError(Error)

Some error from the rust htslib library we use to read BAM files

IntConversionError(TryFromIntError)

Error upon conversion from integer

StringConversionError(Utf8Error)

Error involving string conversion

Utf8ConversionError(FromUtf8Error)

Error converting from UTF-8 bytes to string

JsonParseError(Error)

Error parsing JSON

OrdPairConversion(String)

OrdPair is an ordered pair, which can be obtained from a string of the correct format. This error says string conversion failed.

IntParseError(ParseIntError)

Problem parsing integers

FloatParseError(ParseFloatError)

Problem parsing floats

InputOutputError(Error)

Generic Input-Output error

FormattingError(Error)

Generic formatting error

CsvError(Error)

Problem reading or parsing CSV files

InvalidDuplicates(String)

Error when unexpected duplicates are seen

InvalidState(String)

Generic error used when program hits an invalid state

WriteOutput(String)

Error while writing output

NotImplemented(String)

Generic not implemented error

WrongOrder(String)

General error when ordering of items in some context is wrong.

UnavailableData(String)

Data not available

Unmapped(String)

Read is unmapped, use this whenever some function meant for a mapped read is called on an unmapped read

Zero(String)

Zero values used where they should not be

ZeroSeqLen(String)

Zero sequence length

InvalidRegion

Genomic region coordinates exceed contig boundaries

Fields

region: String

The original region string provided by the user

pos: u64

The position that exceeds the contig boundary

contig_length: u64

The actual length of the contig

InvalidSorting(String)

Sorting validation failure

WindowDensBelowThres

Window density is below threshold

Fields

density: F32Bw0and1

The density value that was below threshold

threshold: F32Bw0and1

The threshold value

EmptyWindow(String)

Window does not contain any data

InsufficientDataSize(String)

Data is not of sufficient size (e.g. in a window)

Arithmetic(String)

Arithmetic error

BuilderError(UninitializedFieldError)

Problem parsing items while building structs with Builder methods

BuilderValidation(String)

Problem validating items with a Builder method

FromCharError(TryFromCharError)

Problem parsing items while converting between DNA base representations

PolarsError(PolarsError)

Error from Polars during DataFrame construction or manipulation

SimulateDNASeqCIGAREndProblem(String)

Error simulating DNA sequences

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseFloatError> for Error

fn from(source: ParseFloatError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(source: ParseIntError) -> Self

Converts to this type from the input type.

impl From<PolarsError> for Error

fn from(source: PolarsError) -> Self

Converts to this type from the input type.

impl From<TryFromCharError> for Error

fn from(source: TryFromCharError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(source: TryFromIntError) -> Self

Converts to this type from the input type.

impl From<UninitializedFieldError> for Error

fn from(source: UninitializedFieldError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.