WordVariant

A variant of Types packed into a word (size_t).

Suitable for use in tree-data containers, such as radix trees (tries), where hybrid value (sparsely packed sub-tree) and pointer (to dense sub-tree) packing of sub-nodes is needed.

struct WordVariant (

Types...

) {

alias allSame = allSameIterative via import nxt.traits_ex : allSame, sizesOf;;

template sizesOf(T...) via import nxt.traits_ex : allSame, sizesOf;;

alias S = size_t;

template makeEnumFromSymbolNames(string prefix = `__`, string suffix = ``, bool firstUndefined = true, bool useMangleOf = false, Es...) via import nxt.typecons_ex : makeEnumFromSymbolNames;;

alias Ix = makeEnumFromSymbolNames!(`ix_`, ``, true, false, Types);

template bitsNeeded(size_t length) via import nxt.bit_traits : bitsNeeded;;

enum typeBits;

enum typeShift;

enum typeMask;

import std.meta : staticIndexOf;;

eponymoustemplate indexOf(T);

eponymoustemplate canStore(T);

string toString [@property getter];

auto toHash();

this(T value);

this(typeof(null) value);

this(WordVariant!(SubTypes) value);

auto ref opAssign(typeof(this) value);

auto ref opAssign(T that);

auto ref opAssign(typeof(null) that);

auto ref opAssign(WordVariant!(SubTypes) value);

inout(Ref!T) peek [@property getter];

bool opEquals(WordVariant that);

bool opEquals(T that);

}

Constructors

this this(T value)
this(typeof(null) value): Construction from value.
this this(WordVariant!(SubTypes) value): Construction from sub-variant value.

Members

Aliases

Ix alias Ix = makeEnumFromSymbolNames!(`ix_`, ``, true, false, Types): Undocumented in source.
S alias S = size_t: Undocumented in source.

Enums

canStore eponymoustemplate canStore(T): Is true iff a T can be stored.
indexOf eponymoustemplate indexOf(T): Undocumented in source.

Functions

as inout(T) as(): Undocumented in source. Be warned that the author may not have intended to support it.
isNull bool isNull(): Undocumented in source. Be warned that the author may not have intended to support it.
opAssign auto ref opAssign(typeof(this) value)
auto ref opAssign(T that)
auto ref opAssign(typeof(null) that): Assignment from that.
opAssign auto ref opAssign(WordVariant!(SubTypes) value): Assignment from sub-variant value.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(WordVariant that): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(T that): Undocumented in source. Be warned that the author may not have intended to support it.
toHash auto toHash(): Undocumented in source. Be warned that the author may not have intended to support it.
typeIx Ix typeIx(): Get zero-offset index as Ix of current variant type.

Manifest constants

typeBits enum typeBits;: Undocumented in source.
typeMask enum typeMask;: Undocumented in source.
typeShift enum typeShift;: Undocumented in source.

Properties

peek inout(Ref!T) peek [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
toString string toString [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.