Enum ADRuleError 

pub enum ADRuleError {
    Unsupported {
        op: String,
        rule: ADRuleKind,
    },
}

Error returned when an AD rule cannot be emitted.

Examples

use tidu::{ADRuleError, ADRuleKind};

let err = ADRuleError::unsupported("my_crate::fft", ADRuleKind::Jvp);
assert_eq!(err.rule(), ADRuleKind::Jvp);
assert!(err.to_string().contains("my_crate::fft"));

Variants

Unsupported

The requested primitive does not provide the requested AD rule.

Fields

op: String

Stable primitive name or extension family identifier.

rule: ADRuleKind

Missing rule kind.

Implementations

impl ADRuleError

pub fn unsupported(op: impl Into<String>, rule: ADRuleKind) -> Self

Constructs an unsupported-rule error.

Examples

use tidu::{ADRuleError, ADRuleKind};

let err = ADRuleError::unsupported("custom::op", ADRuleKind::Transpose);
assert_eq!(err.rule(), ADRuleKind::Transpose);

pub const fn rule(&self) -> ADRuleKind

Returns the AD rule kind associated with this error.

Examples

use tidu::{ADRuleError, ADRuleKind};

let err = ADRuleError::unsupported("custom::op", ADRuleKind::Jvp);
assert_eq!(err.rule(), ADRuleKind::Jvp);

Trait Implementations

impl Clone for ADRuleError

fn clone(&self) -> ADRuleError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ADRuleError

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

Formats the value using the given formatter.

impl Display for ADRuleError

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

Formats the value using the given formatter.

impl Error for ADRuleError

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 ADRuleError

fn eq(&self, other: &ADRuleError) -> 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 ADRuleError

impl StructuralPartialEq for ADRuleError