Skip to main content

BookPage

Enum BookPage 

Source
pub enum BookPage {
    Text {
        text: String,
    },
    Spotlight {
        item: ItemDef,
        title: Option<String>,
        text: Option<String>,
    },
    Crafting {
        recipe_id: String,
        text: Option<String>,
    },
    Smelting {
        recipe_id: String,
        text: Option<String>,
    },
    Image {
        texture: String,
        title: Option<String>,
        text: Option<String>,
        border: bool,
    },
    Entity {
        entity_type: String,
        name: Option<String>,
        text: Option<String>,
    },
    Relations {
        entries: Vec<String>,
        text: Option<String>,
    },
    Empty,
}
Expand description

A single page variant inside a book entry.

Variants§

§

Text

Plain formatted text (Markdown-like, with macro support).

Fields

§text: String
§

Spotlight

Display an item outlined (tooltip on hover).

Fields

§item: ItemDef
§

Crafting

Crafting recipe display (autorenders 3×3 grid).

Fields

§recipe_id: String
§

Smelting

Smelting recipe display.

Fields

§recipe_id: String
§

Image

Image overlay page.

Fields

§texture: String
§border: bool
§

Entity

Entity display page (renders a living entity in a box).

Fields

§entity_type: String
§

Relations

Link to another entry (like Patchouli’s relations).

Fields

§entries: Vec<String>
§

Empty

Empty separator.

Trait Implementations§

Source§

impl Clone for BookPage

Source§

fn clone(&self) -> BookPage

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 Debug for BookPage

Source§

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

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.