Struct Scene 

pub struct Scene {
    pub number: usize,
    pub heading: String,
    pub page: Option<u32>,
    pub body: String,
}

A single scene in the screenplay.

Scenes are delimited by Scene Heading paragraphs. Everything between two consecutive headings belongs to the first scene.

Example

let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<document type="Open Screenplay Format document" version="40">
  <info/><settings/><styles/>
  <paragraphs>
    <para page_number="3" number="5">
      <style basestyle="Scene Heading"/>
      <text>EXT. ROOFTOP - NIGHT</text>
    </para>
    <para><style basestyle="Action"/><text>Wind howls.</text></para>
    <para><style basestyle="Character"/><text>MAYA</text></para>
    <para><style basestyle="Dialogue"/><text>We have to jump.</text></para>
  </paragraphs>
  <titlepage/><lists/>
</document>"#;

let doc = osf::parse(xml.as_bytes()).unwrap();
let scene = &doc.scenes[0];
assert_eq!(scene.number, 5);
assert_eq!(scene.heading, "EXT. ROOFTOP - NIGHT");
assert_eq!(scene.page, Some(3));
assert!(scene.body.contains("MAYA"));

Fields

number: usize

Scene number. Uses the explicit number from the XML if present, otherwise falls back to sequential numbering.

heading: String

The scene heading text (e.g., "INT. COFFEE SHOP - DAY").

page: Option<u32>

Page number where the scene starts, if available.

body: String

The scene body — all paragraphs formatted as screenplay text.

Trait Implementations

impl Clone for Scene

fn clone(&self) -> Scene

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scene

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

Formats the value using the given formatter.

impl Serialize for Scene

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.