Enum PageElement 

pub enum PageElement {
    Header {
        text: String,
        visible: Option<String>,
    },
    Text {
        text: String,
        visible: Option<String>,
    },
    Item {
        item: String,
        visible: Option<String>,
    },
    Image {
        image: String,
        height: f32,
        visible: Option<String>,
    },
    Drawn {
        drawer: String,
        height: f32,
        data: String,
        visible: Option<String>,
    },
    Spacer {
        height: f32,
    },
}

One thing a page of the type shows, top to bottom.

Variants

Header

The page’s title, centred.

Fields

text: String

visible: Option<String>

Text

Book text, wrapped to the page.

Fields

text: String

visible: Option<String>

Item

An item’s icon, centred.

Fields

item: String

visible: Option<String>

Image

An image the page’s width.

Fields

image: String

height: f32

visible: Option<String>

Drawn

A picture the mod’s code draws (Registry::on_book_page).

Fields

drawer: String

height: f32

data: String

visible: Option<String>

Spacer

Room.

Fields

height: f32

Trait Implementations

impl Clone for PageElement

fn clone(&self) -> PageElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageElement

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

Formats the value using the given formatter.

impl PartialEq for PageElement

fn eq(&self, other: &PageElement) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Schema for PageElement

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<PageElement>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn encode(&self, w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(d: &mut Decoder<'_>) -> Option<Self>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(u: &mut Unpacker<'_>) -> Option<Self>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for PageElement