Capacity v0.1.0

Package: Text

Signature

func Capacity(self) -> uint;

Returns

The size of the block in bytes, and 0 for a builder that has not taken one yet. Everything up to this can be written without reallocating; the first byte past it doubles the block.

Capacity only ever grows on its own — Clear keeps it, and Shrink is what hands it back.

Example

import Text::StringBuilder;

func Main() -> int {
    var builder = StringBuilder::New();
    builder.Capacity(); // 0

    builder.Append("Rux");
    builder.Capacity(); // 16 -- the floor the first append takes

    builder.Clear();
    builder.Capacity(); // 16 still -- Clear keeps the block

    builder.Free();
    return 0;
}

See also

• StringBuilder — the builder type
• Length — how much of the capacity is used
• Reserve — ask for more room up front
• Shrink — hand back what is unused