Option type explained

In programming languages (especially functional programming languages) and type theory, an option type or maybe type is a polymorphic type that represents encapsulation of an optional value; e.g., it is used as the return type of functions which may or may not return a meaningful value when they are applied. It consists of a constructor which either is empty (often named None or Nothing), or which encapsulates the original data type A (often written Just A or Some A).

A distinct, but related concept outside of functional programming, which is popular in object-oriented programming, is called nullable types (often expressed as A?). The core difference between option types and nullable types is that option types support nesting (e.g. Maybe (Maybe String)Maybe String), while nullable types do not (e.g. String?? = String?).

Theoretical aspects

In type theory, it may be written as:

A?=A+1

. This expresses the fact that for a given set of values in

A

, an option type adds exactly one additional value (the empty value) to the set of valid values for

A

. This is reflected in programming by the fact that in languages having tagged unions, option types can be expressed as the tagged union of the encapsulated type plus a unit type.[1]

In the Curry–Howard correspondence, option types are related to the annihilation law for ∨: x∨1=1.

An option type can also be seen as a collection containing either one or zero elements.

The option type is also a monad where:[2]

return = Just -- Wraps the value into a maybe

Nothing >>= f = Nothing -- Fails if the previous monad fails(Just x) >>= f = f x -- Succeeds when both monads succeed

The monadic nature of the option type is useful for efficiently tracking failure and errors.[3]

Examples

Agda

In Agda, the option type is named with variants and .

C++

Since C++17, the option type is defined in the standard library as .

Coq

In Coq, the option type is defined as .

Elm

In Elm, the option type is defined as .[4]

F#

let showValue = Option.fold (fun _ x -> sprintf "The value is: %d" x) "No value"

let full = Some 42let empty = None

showValue full |> printfn "showValue full -> %s"showValue empty |> printfn "showValue empty -> %s"

showValue full -> The value is: 42showValue empty -> No value

Haskell

In Haskell, the option type is defined as .[5]

showValue :: Maybe Int -> StringshowValue = foldl (\_ x -> "The value is: " ++ show x) "No value"

main :: IO main = do let full = Just 42 let empty = Nothing

putStrLn $ "showValue full -> " ++ showValue full putStrLn $ "showValue empty -> " ++ showValue empty

showValue full -> The value is: 42showValue empty -> No value

Idris

In Idris, the option type is defined as .

showValue : Maybe Int -> StringshowValue = foldl (\_, x => "The value is " ++ show x) "No value"

main : IO main = do let full = Just 42 let empty = Nothing

putStrLn $ "showValue full -> " ++ showValue full putStrLn $ "showValue empty -> " ++ showValue empty

showValue full -> The value is: 42showValue empty -> No value

Nim

import std/options

proc showValue(opt: Option[int]): string = opt.map(proc (x: int): string = "The value is: " & $x).get("No value")

let full = some(42) empty = none(int)

echo "showValue(full) -> ", showValue(full)echo "showValue(empty) -> ", showValue(empty)

showValue(full) -> The Value is: 42showValue(empty) -> No value

OCaml

In OCaml, the option type is defined as .[6]

let show_value = Option.fold ~none:"No value" ~some:(fun x -> "The value is: " ^ string_of_int x)

let = let full = Some 42 in let empty = None in

print_endline ("show_value full -> " ^ show_value full); print_endline ("show_value empty -> " ^ show_value empty)

show_value full -> The value is: 42show_value empty -> No value

Rust

In Rust, the option type is defined as .[7]

fn show_value(opt: Option) -> String

fn main

show_value(full) -> The value is: 42show_value(empty) -> No value

Scala

In Scala, the option type is defined as, a type extended by and .

object Main: def showValue(opt: Option[Int]): String = opt.fold("No value")(x => s"The value is: $x")

def main(args: Array[String]): Unit = val full = Some(42) val empty = None

println(s"showValue(full) -> $") println(s"showValue(empty) -> $")

showValue(full) -> The value is: 42showValue(empty) -> No value

Standard ML

In Standard ML, the option type is defined as .

Swift

In Swift, the option type is defined as but is generally written as .[8]

func showValue(_ opt: Int?) -> String

let full = 42let empty: Int? = nil

print("showValue(full) -> \(showValue(full))")print("showValue(empty) -> \(showValue(empty))")

showValue(full) -> The value is: 42showValue(empty) -> No value

Zig

In Zig, add ? before the type name like ?i32 to make it an optional type.

Payload n can be captured in an if or while statement, such as, and an else clause is evaluated if it is null.

const std = @import("std");

fn showValue(allocator: std.mem.Allocator, opt: ?i32) ![]u8

pub fn main !void

showValue(allocator, full) -> The value is: 42 showValue(allocator, empty) -> No value

See also

Notes and References

  1. Web site: Simple Algebraic Data Types. Milewski. Bartosz. 2015-01-13. Bartosz Milewski's Programming Cafe. Sum types. "We could have encoded Maybe as: data Maybe a = Either a". en. https://web.archive.org/web/20190818084741/https://bartoszmilewski.com/2015/01/13/simple-algebraic-data-types/. 2019-08-18. live. 2019-08-18.
  2. Web site: A Fistful of Monads - Learn You a Haskell for Great Good!. www.learnyouahaskell.com. 2019-08-18.
  3. Web site: What is a Monad?. https://ghostarchive.org/varchive/youtube/20211220/t1e8gqXLbsU . 2021-12-20 . live. Hutton. Graham. Nov 25, 2017. Computerphile Youtube. Aug 18, 2019.
  4. Web site: Maybe · An Introduction to Elm . guide.elm-lang.org.
  5. Web site: 6 Predefined Types and Classes . 2022-06-15 . www.haskell.org.
  6. Web site: OCaml library : Option . 2022-06-15 . v2.ocaml.org.
  7. Web site: Option in core::option - Rust . 2022-05-18 . 2022-06-15 . doc.rust-lang.org.
  8. Web site: Apple Developer Documentation. 2020-09-06. developer.apple.com.