Struct BoxTarget 

pub struct BoxTarget<ET: EngineTypes>(/* private fields */);

Once a box is closed, something is supposed to happen to it; most commonly, it is just added to the parent node list; but occasionally, something else should happen to it - e.g. \setbox5\hbox{...} implies that after the node list of the box is closed, it should be put into the box register with index 5 instead. This struct abstracts over that by carrying a continuation function to be called when the box is closed.

TODO: rethink this in light of ListTarget.

Implementations

impl<ET: EngineTypes> BoxTarget<ET>

pub fn new<F: FnOnce(&mut EngineReferences<'_, ET>, TeXBox<ET>) -> TeXResult<(), ET> + 'static>( f: F, ) -> Self

Create a new box target from the given continuation function.

pub fn call( self, engine: &mut EngineReferences<'_, ET>, bx: TeXBox<ET>, ) -> TeXResult<(), ET>

Execute the continuation function (once the box is closed)

pub fn none() -> Self

Create a trivial box target

pub fn is_some(&self) -> bool

Whether the continuation function has not yet been called

Trait Implementations

impl<ET: EngineTypes> Clone for BoxTarget<ET>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ET: EngineTypes> Debug for BoxTarget<ET>

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

Formats the value using the given formatter.