moddef::Document Class Reference

A parsed ModDef document. More...

#include <document.hpp>

Public Member Functions
std::string_view	doc_id () const noexcept
const md_doc_t *	c_doc () const noexcept
	Document (Document &&o) noexcept
Document &	operator= (Document &&o) noexcept
	Document (const Document &)=delete
Document &	operator= (const Document &)=delete

Static Public Member Functions
static Result< Document >	view (std::span< const std::uint8_t > bytes)
	View over external bytes (no copy).
static Result< Document >	own (std::vector< std::uint8_t > bytes)
	Take ownership of a byte buffer (host-side convenience).

Detailed Description

A parsed ModDef document.

Non-copyable; movable (the owned buffer, if any, keeps its address across a move).

Constructor & Destructor Documentation

Document() [1/2]

moddef::Document::Document ( Document &&  o )

inlinenoexcept

Document() [2/2]

moddef::Document::Document ( const Document &  )

delete

Member Function Documentation

view()

static Result< Document > moddef::Document::view ( std::span< const std::uint8_t >  bytes )

inlinestatic

View over external bytes (no copy).

The bytes must outlive the Document.

own()

static Result< Document > moddef::Document::own ( std::vector< std::uint8_t >  bytes )

inlinestatic

Take ownership of a byte buffer (host-side convenience).

doc_id()

std::string_view moddef::Document::doc_id ( ) const

inlinenoexcept

c_doc()

const md_doc_t * moddef::Document::c_doc ( ) const

inlinenoexcept

operator=() [1/2]

Document & moddef::Document::operator= ( Document &&  o )

inlinenoexcept

operator=() [2/2]

Document & moddef::Document::operator= ( const Document &  )

delete

---

The documentation for this class was generated from the following file:

• include/moddef/document.hpp