optional 0.4.1

An optional/maybe type with range semantics


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

Optional type for D

Latest version Build Status codecov license

Full API docs available here

Represents an optional data type that may or may not contain a value. Matches behavior of haskell maybe and scala or swift optional type. With the added benefit (like scala) of behving like an single element or empty D range.

You may think it a cross between std.range.only, std.typecons.nullable and a pointer type.

Motivation

Lets take a very contrived example, and say you have a function that may return a value (that should be some integer) or not (config file, server, find operation, whatever), and then you have functions add1, add2, and add3, what have the requirements that they may or may not produce a value. (maybe they do some crazy division, or they contact a server themselves to fetch a value, etc).

How can you go about this? Can you use pointers?

int* add1(int *v) {
  // Gotta remember to protect against null
  if (!v) {
    return v;
  }
  *v += 1;
  return v;
}

int* add2(int *v); // might forget to check for null
int* add3(int *v); // might forget to check for null

void f() {
  int* v = maybeGet();
  if (v)
    v = v.add1;
  if (v)
    v = v.add2;
  if (v)
    v = v.add3;
  if (v)
    writeln(*v);
}

You can also replace int with Nullable!int and then instead of `if (v)` you'd have to do `if (!v.isNull)` and instead of `v you'd do v.get`.

How about ranges? There's std.range.only:

// How do I write it?
// Is Only!T a type?
// It's not documented though
// But Only!T is actually Only!(T0, T1, T3 ..., TN) ??
// What do I do with that?
auto add2(Range)(Range r)
if (isInputRange!Range && is(ELementType!Range == int)) // constrain to range type only and int element type?
{
  // do we have one element or more now?
  // what do we do if there's more than one?
  // do we restrain it at run time to being there?
  enforce(r.walkLength <= 1); // ??
  // Should we map all of it?
  return v.map!(a => a + 1);
  // Or just the first?
  return v.take(1).map!(a => a + 1);
  // But what do I do with the rest then?
}

auto add2(Range)(Range r) if (isInputRange!Range) {
  // same headache as above
}

auto add3(Range)(Range r) if (isInputRange!Range) {
  // same headache as above
}

void f() {
  auto v = maybeGet();
  // can we assign it to itself?
  v = v.add1.add2.add3;
  // No, no idea what it returns, not really the same type
  // so this...
  refRange(&v).add1.add2.add3; // ??
  // no that won't work (can it?), lets create a new var
  auto v2 = v.add1.add2.add3 // and let type inference do its thing
  writeln(v2); // now ok.
}

Let's try this with an Optional!int

auto add1(Optional!int v) {
  v += 1;
  return v;
}
auto add2(Optional!int v); // same as above
auto add3(Optional!int v); // same as above

void f() {
  auto v = maybeGet();
  v = v.add1.add2.add3;
  writeln(v);
}

Example Optional!T usage follows

E.g.

import optional;

// Create empty optional
auto a = no!int;

// Try doing stuff, all results in none
assert(a == none);

++a; // none;
a - 1; // none;

// Assign and try doing the same stuff
a = 9;
assert(a == some(9));

++a; // some(10);
a - 1; // some(9);

// Acts like a range as well

import std.algorithm: map;
import std.conv: to;

auto b = some(10);
auto c = no!int;

b.map!(to!double) // [10.0]
c.map!(to!double) // empty

// Can safely dispatch to whatever inner type is
struct A {
    struct Inner {
        int g() { return 7; }
    }
    Inner inner() { return Inner(); }
    int f() { return 4; }
}

auto d = some(A());

// Dispatch to one of its methods

d.dispatch.f(); // calls a.f, returns some(4)
d.dispatch.inner.g(); // calls a.inner.g, returns some(7)

auto e = no!(A*); 

// If there's no value in the optional or it's a pointer that is null, dispatching still works, but produces none
assert(e.dispatch.f() == none);
assert(e.dispatch.inner.g() == none);

// Set a value and now it will work
e = new A;

assert(e.dispatch.f() == some(4));
assert(e.dispatch.inner.g() == some(7));

Authors:
  • Ali Akhtarzada
Dependencies:
bolts
Versions:
0.4.1 2018-Apr-11
0.4.0 2018-Mar-28
0.3.1 2018-Mar-18
0.3.0 2018-Mar-04
0.2.0 2018-Mar-04
Show all 8 versions
Download Stats:
  • 1 downloads today

  • 10 downloads this week

  • 51 downloads this month

  • 101 downloads total

Score:
1.1
Short URL:
optional.dub.pm