Struct arithmetic_eval::fns::AssertFails

source ·
pub struct AssertFails { /* private fields */ }
Expand description

Assertion that the provided function raises an error. Errors can optionally be matched against a predicate.

If an error is raised, but does not match the predicate, it is bubbled up.

§Type

(using arithmetic-typing notation)

(() -> 'T) -> ()

§Examples

let program = "
    obj = #{ x: 3 };
    assert_fails(|| obj.x + obj.y); // pass: `obj.y` is not defined
    assert_fails(|| obj.x); // fail: function executes successfully
";
let module = Untyped::<F32Grammar>::parse_statements(program)?;
let module = ExecutableModule::new("test_assert", &module)?;

let mut env = Environment::new();
env.insert_native_fn("assert_fails", fns::AssertFails::default());

let err = module.with_env(&env)?.run().unwrap_err();
assert_eq!(
    err.source().location().in_module().span(program),
    "assert_fails(|| obj.x)"
);

Custom error matching:

let assert_fails = fns::AssertFails::new(|err| {
    matches!(err.kind(), ErrorKind::NativeCall(_))
});

let program = "
    assert_fails(|| assert_fails(1)); // pass: native error
    assert_fails(assert_fails); // fail: arg len mismatch
";
let module = Untyped::<F32Grammar>::parse_statements(program)?;
let module = ExecutableModule::new("test_assert", &module)?;

let mut env = Environment::new();
env.insert_native_fn("assert_fails", assert_fails);

let err = module.with_env(&env)?.run().unwrap_err();
assert_eq!(
    err.source().location().in_module().span(program),
    "assert_fails(assert_fails)"
);

Implementations§

source§

impl AssertFails

source

pub fn new(error_matcher: fn(_: &Error) -> bool) -> Self

Creates an assertion function with a custom error matcher. If the error does not match, the assertion will fail, and the error will bubble up.

Trait Implementations§

source§

impl Clone for AssertFails

source§

fn clone(&self) -> AssertFails

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for AssertFails

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for AssertFails

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<T: 'static + Clone> NativeFn<T> for AssertFails

source§

fn evaluate( &self, args: Vec<SpannedValue<T>>, ctx: &mut CallContext<'_, T>, ) -> EvalResult<T>

Executes the function on the specified arguments.
source§

impl Copy for AssertFails

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.