Struct DocStore 

pub struct DocStore {
    pub entries: Vec<String>,
}

The engine documentation store: per-symbol Markdown doc text addressed by DocId.

Encoded into a separate engine_docs.bin blob (deliberately not a field of ApiData) and embedded native-only behind the bundled-docs feature. This keeps the doc prose out of the engine_api.bin blob the wasm playground fetches — populating the doc: Option<DocId> fields is a fixed-size change to that blob, so the wasm download never grows with the docs (Playbook §4.6; crates/gdscript-api/src/lib.rs).

Fields

entries: Vec<String>

Markdown entries; DocId(i) addresses entries[i]. Every entry is non-empty — a symbol with no documentation carries doc: None, never an index to an empty string.

Implementations

impl DocStore

pub fn get(&self, id: DocId) -> Option<&str>

The Markdown for a doc handle, or None if the index is out of range.

impl DocStore

pub fn from_bytes(bytes: &[u8]) -> Result<Self, LoadError>

Decode an engine_docs.bin blob produced by xtask codegen-api.

The bytes are copied into a 16-byte-aligned buffer before validation, mirroring EngineApi::from_bytes, so a misaligned source decodes correctly.

Errors

Returns LoadError::Decode if the blob fails rkyv validation.

Trait Implementations

impl Archive for DocStore

where Vec<String>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedDocStore

The archived representation of this type.

type Resolver = DocStoreResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Debug for DocStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<DocStore, __D> for Archived<DocStore>

where Vec<String>: Archive, <Vec<String> as Archive>::Archived: Deserialize<Vec<String>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<DocStore, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl<__S: Fallible + ?Sized> Serialize<__S> for DocStore

where Vec<String>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.