Enum ConversionError 

#[non_exhaustive]
pub enum ConversionError {
    NotImplemented(&'static str),
    InvalidSource(String),
    UnrepresentableTarget(String),
}

Reason a conversion can fail.

The NotImplemented variant is the placeholder every pre-implementation function returns. Subsequent issues (#2053 iReal→ChordPro, #2061 ChordPro→iReal) replace those returns with real implementations; new variants are added at the bottom of the enum to preserve compatibility with code that matches on the existing variants.

Marked #[non_exhaustive] so adding a new variant in a follow-up PR is non-breaking for downstream match expressions, matching the additive-evolution contract documented at the crate root.

Note for future implementers

Once #2053 / #2061 land, Self::InvalidSource and Self::UnrepresentableTarget will carry parser-derived, potentially attacker-controlled text. Implementations SHOULD truncate or sanitise their messages before constructing these variants; downstream Display consumers and log forwarders MUST NOT assume bounded length until that bound is enforced upstream. (Same pattern as chordsketch_ireal::json::truncate_for_message.)

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.

NotImplemented(&'static str)

The conversion direction is recognised but not yet implemented in this crate version. The contained &'static str is the URL of the issue tracking the implementation so callers can give a useful diagnostic.

InvalidSource(String)

The source value was structurally invalid and could not be converted at all (distinct from a lossy-but-successful conversion, which returns Ok with warnings).

UnrepresentableTarget(String)

The conversion would produce a target value that is not representable in the target format (e.g. an out-of-range time signature on the iReal side).

Trait Implementations

impl Clone for ConversionError

fn clone(&self) -> ConversionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConversionError

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

Formats the value using the given formatter.

impl Display for ConversionError

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

Formats the value using the given formatter.

impl Error for ConversionError

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 PartialEq for ConversionError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConversionError

impl StructuralPartialEq for ConversionError