Struct bones_framework::prelude::piccolo::Fuel

pub struct Fuel { /* private fields */ }

A counter for tracking the amount of time spent in Executor::step and in callbacks.

The fuel unit is approximately one VM instruction, but this is just a rough estimate (especially since VM instructions are highly variable in cost, such as with the len operator).

All operations that take a variable amount of time should consume some amount of fuel, so that it is always possible to bound the amount of time spent in Executor::step.

Implementations

impl Fuel

pub fn empty() -> Fuel

pub fn with(fuel: i32) -> Fuel

pub fn refill(&mut self, fuel: i32, max_fuel: i32)

Refills fuel up to a given maximum and also clears the fuel interrupt flag.

This is a convenience method that is intended to be called outside of a call to Executor::step in some loop. It does the operations that all loops that would re-use a fuel container from one tick to another would need to do.

It credits the running thread with fuel while also preventing available fuel from growing to an unbounded level, and also clears the interrupt flag since we are now on the “outside” of whatever lua code is being run and this is where we would want to interrupt to.

pub fn adjust(&mut self, fuel: i32)

Add to or subtract from the current remaining fuel.

pub fn consume(&mut self, fuel: i32)

Subtract from the current remaining fuel.

This is a convenience method that is equivalent to self.adjust_fuel(-fuel).

pub fn remaining(&self) -> i32

pub fn set_remaining(&mut self, fuel: i32)

pub fn interrupt(&mut self)

Marks that the calling Executor should immediately stop executing, without actually consuming any fuel.

This is useful in situations where you need to interrupt a running Executor because it may be waiting on an external event that has not yet occurred, but still want to record the correct fuel usage.

pub fn is_interrupted(&self) -> bool

pub fn clear_interrupt(&mut self)

pub fn should_continue(&self) -> bool

Returns true if we have positive fuel remaining and we have not been interrupted.

Trait Implementations

impl Clone for Fuel

fn clone(&self) -> Fuel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fuel

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

Formats the value using the given formatter.