Struct Request 

pub struct Request {
    pub format: String,
    pub project_name: String,
    pub language: String,
    pub top_level_as_chapters: bool,
    pub chapters: Vec<Chapter>,
    pub settings: Map<String, Value>,
    pub locale: Option<String>,
    pub images: Vec<Image>,
    pub cover_image_id: Option<i32>,
}

Fields

format: String

Which of the manifest’s [[exporters]] formats to render.

project_name: String

language: String

The project’s BCP 47 tag.

top_level_as_chapters: bool

Whether the scene tree’s top-level nodes are chapters; when not, the story is one chapter.

chapters: Vec<Chapter>

settings: Map<String, Value>

The plugin’s declared settings, every key present.

locale: Option<String>

The UI’s BCP 47 tag, for replying in the user’s language; not Request::language, the story’s.

images: Vec<Image>

For a format whose manifest entry sets images = true, each project image the story refers to whose file Hammer could read, sorted by id, and the cover with cover = true; empty otherwise.

cover_image_id: Option<i32>

The cover’s id among Request::images, with cover = true; none when the project has no cover or its file could not be read.

Implementations

impl Request

pub fn image(&self, id: i32) -> Option<&Image>

The image id among Request::images, or none when it is not there.

pub fn cover(&self) -> Option<&Image>

The cover among Request::images, or none when there is none.

Trait Implementations

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.