SSOString

Small-size-optimized (SSO) variant of string.

Storage is placed on the stack if the number of chars is less than smallCapacity, otherwise as a normal (large) string. The large string will be allocated on the GC-heap if the SSOString is constructed from a non-string (non-immutable char[]) parameter.

Because SSOString doesn't have a destructor it can safely allocate using a GC-backed region allocator without relying on a GC finalizer.

In order to mimic string/array/slice-behaviour, opCast returns false for SSOString() and true for SSOString(""). This requires SSOString() to default to a large string in which large pointer is set to null.

Big-endian platform support hasn't been verified.

Constructors

this this(Chars source): Construct from source, which potentially needs GC-allocation (iff source.length > smallCapacity and source is not a string).
this this(Source source): Construct from source of dchar

Members

Aliases

opDollar alias opDollar = length: Get length.

Functions

empty bool empty(): Check if this is empty.
holeify void holeify(): That this a hole, meaning a removed/erase value.
isHole bool isHole(): Check if this a hole, meaning a removed/erase value.
isSmallASCII bool isSmallASCII(): Check if this is a small ASCII string.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(this) rhs): Check if this is equal to rhs.
opEquals bool opEquals(const(char)[] rhs): Check if this is equal to rhs.
opIndex inout(char) opIndex(size_t index): Return the indexed char of this.
opSlice inout(char)[] opSlice(): Return a slice to either the whole large or whole small string.
opSlice inout(char)[] opSlice(size_t i, size_t j): Return a slice at [i .. j] to either the internally stored large or small string.

Manifest constants

smallCapacity enum smallCapacity;: Undocumented in source.

Properties

isNull bool isNull [@property getter]: Check if this is null.
length size_t length [@property getter]: Get length.
opCmp typeof(this) opCmp [@property setter]: Compare this with that.
toHash hash_t toHash [@property getter]: Get hash of this, with extra fast computation for the small case.
toString Sink toString [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
toString string toString [@property getter]: Return this converted to a string, without any GC-allocation because this is immutable.
toString string toString [@property getter]: Return this converted to a string, which potentially needs GC-allocation (iff length > smallCapacity).

Static variables

holeValue auto holeValue;: Support trait isHoleable.
nullValue auto nullValue;: Support trait isNullable.