Result and try
Result #
A function that can fail returns Result[T]. It is either ok(value) or error(message). The error holds an Error record, whose message is a String. A value that may simply be missing, with no error to report, is an Optional instead.
def divide(a: Int, b: Int) -> Result[Int]
return error("division by zero") if b == 0
ok(a / b)
end
def main() -> Void
puts(divide(10, 2))
puts(divide(1, 0))
endok(5)
error("division by zero")Look inside a Result #
def main() -> Void
good = "12".to_i
bad = "x".to_i
puts(good.ok?)
puts(bad.ok?)
puts(good.unwrap!)
puts(bad.unwrap_or(0))
puts(bad.message)
endtrue
false
12
0
cannot convert "x" to Intunwrap! stops the program when the Result is an error:
def main() -> Void
_n = "x".to_i.unwrap!
enderror[RUNTIME-UNWRAP-ERROR]case on a Result #
ok(...) and error(...) also work as patterns. error(e) binds the Error: "#{e}" and puts(e) give its message, and e.message is the String itself.
def main() -> Void
case "42".to_i
ok(n) -> puts("number #{n}")
error(message) -> puts("bad: #{message}")
end
endnumber 42try #
try takes the value out of an ok. On an error, it returns that error from the current function at once. The function must return a Result.
def add_texts(a: String, b: String) -> Result[Int]
x = try a.to_i
y = try b.to_i
ok(x + y)
end
def main() -> Void
puts(add_texts("2", "3"))
puts(add_texts("2", "three"))
endok(5)
error("cannot convert \"three\" to Int", kind: "number.parse")Results with no value #
Result[Void] means “worked, or failed with a message”. Return ok() on success.
def check_age(age: Int) -> Result[Void]
return error("age must not be negative") if age < 0
ok()
end
def main() -> Void
puts(check_age(30))
puts(check_age(-1))
endok()
error("age must not be negative")A Result must be used #
A call whose Result is dropped would lose its error, so it is CHECK-UNUSED-RESULT. It holds for any call, yours or a builtin, and for Result[Void] too.
def check_age(age: Int) -> Result[Void]
return error("age must not be negative") if age < 0
ok()
end
def main() -> Void
check_age(-1)
enderror[CHECK-UNUSED-RESULT]Handle it with try, a case or unwrap!. To drop it on purpose, write _ = in front of the call:
def check_age(age: Int) -> Result[Void]
return error("age must not be negative") if age < 0
ok()
end
def main() -> Void
_ = check_age(-1)
case check_age(30)
ok(_) -> puts("fine")
error(message) -> puts(message)
end
endfineError needs a type #
error("...") alone does not say which Result it is. Give it a type, for example with an annotation:
def main() -> Void
r: Result[Int] = error("not ready")
puts(r.unwrap_or(-1))
end-1Without the annotation, r = error("not ready") is the error CHECK-RESULT-TYPE.
! means it can halt #
By convention, a name ending in ! stops the program on failure; a name ending in ? returns a Bool. to_i returns a Result; to_i! returns the number or halts.