API reference
Preparing search index…

StringIteratorU8

Managed Rml::StringIteratorU8 with one cached native index per byte view.

Movement and dereference use private snapshots with no native calls. Before-begin and end sentinels are numeric offsets, never invalid pointers.

Source & inheritance
Member directory8

Constructors

Methods

Constructors

  • Construct an iterator at a checked UTF-8 byte boundary.

    Parameters

    value
    string | StringView

    Source retained for the iterator's entire lifetime.

    offset
    number = 0

    Start byte offset, default zero.

    countOptional
    number

    Limit end to offset plus count; default the source end.

    Returns

    Source & inheritance

Methods

  • Move backward with the native operator-- boundary rules.

    Returns

    this

    This iterator; decrementing before-begin throws.

    Source & inheritance
  • Resolve native get() as a byte offset inside the retained view.

    Returns

    number

    Current byte offset.

    Source & inheritance
  • Advance with the native operator++ boundary rules.

    Returns

    this

    This iterator; advancing end throws.

    Source & inheritance
  • Read Rml::StringIteratorU8::offset using a safe numeric sentinel.

    Returns

    number

    Byte offset, or minus one before the beginning.

    Source & inheritance
  • Read the native iterator validity contract.

    Returns

    boolean

    Whether the current position can be dereferenced.

    Source & inheritance
  • Read the cached Rml::StringIteratorU8 dereference value.

    Returns

    number

    Native codepoint, or zero for a malformed character.

    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0