Skip to main content

CommandLists

Struct CommandLists 

Source
pub struct CommandLists<'a> { /* private fields */ }
Expand description

Finds every event command list under a file root, without allocating.

What makes the core tier usable for real work. liblcf cannot express it: reaching one map’s commands means parsing the whole rpg::Map into std::vectors, copying every string. Here the traversal is spans into the caller’s buffer, so it runs on a microcontroller against a memory-mapped file.

let mut sink = NullSink;
let mut ctx = Ctx::new(Engine::R2K, &mut sink);
let mut lists = CommandLists::in_map(map_body, 0, &mut ctx);
while let Some(list) = lists.next(&mut ctx) {
    let mut commands = list.commands();
    while let Some(command) = commands.next(&mut ctx) {
        let _ = (command.code, command.string);
    }
}

Implementations§

Source§

impl<'a> CommandLists<'a>

Source

pub fn in_map(body: &'a [u8], base: u32, ctx: &mut Ctx<'_>) -> Self

Every command list in a map, from its root chunk stream.

body is the map’s chunk stream: what load_map parses, minus the file header.

Source

pub fn in_common_events(body: &'a [u8], base: u32, ctx: &mut Ctx<'_>) -> Self

Every common event’s command list, from a database’s chunk stream.

Source

pub fn in_battle_events(body: &'a [u8], base: u32, ctx: &mut Ctx<'_>) -> Self

Every troop page’s command list, from a database’s chunk stream.

Source

pub fn next(&mut self, ctx: &mut Ctx<'_>) -> Option<CommandListAt<'a>>

Yield the next command list.

Trait Implementations§

Source§

impl<'a> Clone for CommandLists<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for CommandLists<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CommandLists<'a>

§

impl<'a> RefUnwindSafe for CommandLists<'a>

§

impl<'a> Send for CommandLists<'a>

§

impl<'a> Sync for CommandLists<'a>

§

impl<'a> Unpin for CommandLists<'a>

§

impl<'a> UnsafeUnpin for CommandLists<'a>

§

impl<'a> UnwindSafe for CommandLists<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.