Skip to main content

Program

Struct Program 

Source
pub struct Program { /* private fields */ }
Expand description

A compiled dialogue program ready to be executed by the runner.

Implementations§

Source§

impl Program

Source

pub fn node_exists(&self, title: &str) -> bool

Returns true if the program contains a node with the given title.

§Example
let prog = bubbles::compile("title: Start\n---\n===\n").unwrap();
assert!(prog.node_exists("Start"));
assert!(!prog.node_exists("Missing"));
Source

pub fn node_titles(&self) -> impl Iterator<Item = &str>

Iterates over all node titles in insertion order.

Source

pub fn node_tags(&self, title: &str) -> Option<&[String]>

Returns the tags of the first node with the given title, if any.

Source

pub fn variable_declarations(&self) -> &[VariableDecl]

Returns all <<declare>> variable declarations found in the program.

This is useful for save systems that need to enumerate every variable a script declares, and for editor tooling.

§Example
let prog = bubbles::compile(
    "title: Start\n---\n<<declare $health = 100>>\n===\n"
).unwrap();
let decls = prog.variable_declarations();
assert_eq!(decls.len(), 1);
assert_eq!(decls[0].name, "$health");
assert_eq!(decls[0].default_src, "100");

Trait Implementations§

Source§

impl Clone for Program

Source§

fn clone(&self) -> Program

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Program

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V