Logo

Programming-Idioms

  • Ada
  • JS
  • Fortran
  • D

Idiom #89 Handle invalid argument

You've detected that the integer value of argument x passed to the current function is invalid. Write the idiomatic way to abort the function execution and signal the problem.

void foo(int x)
in
{
    assert(x != 0, "wrong value for x");
}
body
{
    // function
}

When the software is tested, an input contract can be used to verify x value. In release mode, the input contracts are not included anymore.
import std.format;
throw new Exception("invalid value for x (%s) in '%s'".format(x, __PRETTY_FUNCTION__));

Special keywords such as __FUNCTION__, __FILENAME__,_ _LINE__ can be used to throw a message that's useful.
throw new Error('x is invalid');
  if (x > largest_value) error stop "Illegal value in function."

This will also stop all other images.
enum {
    E_OK,
    E_OUT_OF_RANGE
};

int square(int x, int *result) {
    if (x > 1073741823) {
        return E_OUT_OF_RANGE;
    }
    *result = x*x;
    return E_OK;
}
New implementation...
< > ⌨
programming-idioms.org 
void foo(int x)
in
{
    assert(x != 0, "wrong value for x");
}
body
{
    // function
}
throw new Exception("invalid value for x (%s) in '%s'".format(x, __PRETTY_FUNCTION__));
throw new Error('x is invalid');
  if (x > largest_value) error stop "Illegal value in function."
enum {
    E_OK,
    E_OUT_OF_RANGE
};

int square(int x, int *result) {
    if (x > 1073741823) {
        return E_OUT_OF_RANGE;
    }
    *result = x*x;
    return E_OK;
}
throw domain_error("oops!");
throw new ArgumentException(nameof(×));
error(badarg).
return nil, fmt.Errorf("invalid value for x: %v", x)
throw new IllegalArgumentException("Invalid value for x: $x")
sqrt' :: Int -> Either String Int
sqrt' x | x < 0 = Left "Invalid argument"
sqrt' x         = Right (sqrt x)
void f(int x) {
    Objects.checkIndex(x, 123);
}
<T> void f(T x) throws Exception {
    if (x != value) throw new Exception();
}
throw new IllegalArgumentException("Invalid value for x:" + x);
<T> void f(T x) {
    Objects.requireNonNull(x);
}
error("Invalid argument x")
return nil, "Invalid argument x"
throw new \InvalidArgumentException($x . ' is invalid.');
Raise EInvalidArgument.CreatFmt('Invalid value: %d',[x]);
die "Invalid argument $x";
raise ValueError("x is invalid")
raise ArgumentError, "invalid value #{x}."
enum CustomError { InvalidAnswer }

fn do_stuff(x: i32) -> Result<i32, CustomError> {
    if x != 42 {
        Err(CustomError::InvalidAnswer)
    } else {
        Ok(x)
    }
}