Enum tskit::error::TskitError

pub enum TskitError {
    ValueError {
        got: String,
        expected: String,
    },
    IndexError,
    NotTrackingSamples,
    ErrorCode {
        code: i32,
    },
    MetadataError {
        value: MetadataError,
    },
}

Variants

ValueError

Used when bad input is encountered.

Fields of ValueError

got: Stringexpected: String

IndexError

Used when array access is out of range. Typically, this is used when accessing arrays allocated on the C side.

NotTrackingSamples

Raised when samples are requested from crate::Tree objects, but sample lists are not being updated.

ErrorCode

Wrapper around tskit C API error codes.

Fields of ErrorCode

code: i32

MetadataError

A redirection of crate::metadata::MetadataError

Fields of MetadataError

value: MetadataError

The redirected error

Trait Implementations

impl Debug for TskitError

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

Formats the value using the given formatter.

impl Display for TskitError

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

Formats the value using the given formatter.

impl Error for TskitError

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<MetadataError> for TskitError

fn from(source: MetadataError) -> Self

Performs the conversion.

impl PartialEq<TskitError> for TskitError

fn eq(&self, other: &TskitError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TskitError) -> bool

This method tests for !=.

impl StructuralPartialEq for TskitError