Struct genie_cpx::CampaignWriter

pub struct CampaignWriter<W: Write> { /* fields omitted */ }

A campaign file writer. Instantiate it, then add scenario files to it.

This has to keep all scenario files in memory until the file is written, either on a call to flush() or implicitly when the struct is dropped.

Implementations

impl<W: Write> CampaignWriter<W>

pub fn new(name: &str, writer: W) -> Self

Create a new campaign with user-visible name name, writing to the writer stream.

pub fn version(self, version: CPXVersion) -> Self

Set the file version to output.

pub fn add_raw(&mut self, name: &str, filename: &str, scx: Vec<u8>)

Add a scenario (as a byte array) to this campaign.

pub fn add(&mut self, name: &str, scx: &Scenario) -> SCXResult<()>

Add a Scenario instance from genie-scx to this campaign.

This returns a Result because it serializes the scenario to an in-memory byte array, which may fail.

pub fn into_inner(self) -> W

Consume the CampaignWriter instance, returning the inner Write instance.

pub fn flush(self) -> Result<W>

Write the scenarios to the output stream, consuming the CampaignWriter object.

Returns the inner Write.