ludus::foundation::parsing::ByteCursor

Ludus Wiki · API overview · Browse API

Class

Checked, borrowed input.

Failed operations leave both cursor and output unchanged. There is no native-layout cast, allocation, or hidden I/O.

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

#include <ludus/foundation/parsing/parsing.hpp>

class ludus::foundation::parsing::ByteCursor final

Methods

ByteCursor

explicit ludus::foundation::parsing::ByteCursor::ByteCursor(std::span< const uint8 > input) noexcept

Related types: uint8

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

Position

usize ludus::foundation::parsing::ByteCursor::Position() const noexcept

Related types: usize

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

Remaining

usize ludus::foundation::parsing::ByteCursor::Remaining() const noexcept

Related types: usize

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

Take

bool ludus::foundation::parsing::ByteCursor::Take(usize count, std::span< const uint8 > &output) noexcept

Related types: uint8 · usize

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

Skip

bool ludus::foundation::parsing::ByteCursor::Skip(usize count) noexcept

Related types: usize

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

ReadUint8

bool ludus::foundation::parsing::ByteCursor::ReadUint8(uint8 &output) noexcept

Related types: uint8

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

ReadUint32LittleEndian

bool ludus::foundation::parsing::ByteCursor::ReadUint32LittleEndian(uint32 &output) noexcept

Related types: uint32

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp

ReadUint64LittleEndian

bool ludus::foundation::parsing::ByteCursor::ReadUint64LittleEndian(uint64 &output) noexcept

Related types: uint64

Declared in modules/foundation/parsing/include/ludus/foundation/parsing/parsing.hpp