Struct EffectAnnotation 

pub struct EffectAnnotation {
    pub scheme: EffectScheme,
    pub description: Option<String>,
}

Effect annotation for expressions

Fields

scheme: EffectScheme

The effect scheme for this expression

description: Option<String>

Optional description

Implementations

impl EffectAnnotation

pub fn new(scheme: EffectScheme) -> Self

pub fn with_description(self, description: impl Into<String>) -> Self

pub fn pure() -> Self

Create a pure effect annotation

pub fn differentiable() -> Self

Create a differentiable effect annotation

Trait Implementations

impl Clone for EffectAnnotation

fn clone(&self) -> EffectAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectAnnotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectAnnotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EffectAnnotation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EffectAnnotation

impl StructuralPartialEq for EffectAnnotation