Skip to main content

Line

Enum Line

pub enum Line {
    Text {
        text: String,
        tags: Vec<String>,
    },
    Done {
        text: String,
        tags: Vec<String>,
    },
    Choices {
        text: String,
        tags: Vec<String>,
        choices: Vec<Choice>,
    },
    End {
        text: String,
        tags: Vec<String>,
    },
}

Expand description

A single step of story output from Story::continue_single.

The enum tells the caller what to do next:

Text — more output may follow, keep calling continue_single.
Done — this turn’s output is complete. Call continue_single again for the next turn (the story isn’t over).
Choices — pick a choice via Story::choose, then resume.
End — the story has permanently ended.

Variants§

Text

One line of story content. More may follow — keep calling Story::continue_single.

Fields

§text: String

§tags: Vec<String>

Done

This turn’s output is complete (ink -> DONE). The story isn’t over — call Story::continue_single again for more.

Fields

§text: String

§tags: Vec<String>

Choices

The story is presenting choices. Call Story::choose then resume with Story::continue_single.

Fields

§text: String

§tags: Vec<String>

§choices: Vec<Choice>

End

The story has permanently ended (ink -> END).

Fields

§text: String

§tags: Vec<String>

Implementations§

impl Line

pub fn text(&self) -> &str

The text content of this line, regardless of variant.

pub fn tags(&self) -> &[String]

The tags associated with this line, regardless of variant.

pub fn is_terminal(&self) -> bool

Returns true if this is a terminal variant (Done, Choices, or End).

Trait Implementations§

impl Clone for Line

fn clone(&self) -> Line

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

impl Debug for Line

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Line

impl RefUnwindSafe for Line

impl Send for Line

impl Sync for Line

impl Unpin for Line

impl UnsafeUnpin for Line

impl UnwindSafe for Line

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.