Struct genie::Campaign

pub struct Campaign<R> where
    R: Read + Seek,  { /* fields omitted */ }

A campaign file containing scenario files.

Methods

impl<R> Campaign<R> where
    R: Read + Seek, 

pub fn from(input: R) -> Result<Campaign<R>, ReadCampaignError>

Create a campaign instance from a readable input.

This immediately reads the campaign header and scenario metadata, but not the scenario files themselves.

pub fn into_inner(self) -> R

Consume this Campaign instance and get the reader.

pub fn version(&self) -> [u8; 4]

Get the campaign file version.

pub fn name(&self) -> &str

pub fn entries(&self) -> impl Iterator<Item = &ScenarioMeta>

Iterate over the scenario metadata for this campaign.

pub fn len(&self) -> usize

Get the number of scenarios in this campaign.

pub fn is_empty(&self) -> bool

pub fn get_name(&self, id: usize) -> Option<&str>

pub fn get_filename(&self, id: usize) -> Option<&str>

pub fn by_name(&mut self, filename: &str) -> Result<Scenario, ReadCampaignError>

Get a scenario by its file name.

pub fn by_index(&mut self, index: usize) -> Result<Scenario, ReadCampaignError>

Get a scenario by its campaign index.

pub fn by_name_raw(
    &mut self,
    filename: &str
) -> Result<Vec<u8>, ReadCampaignError>

Get a scenario file buffer by its file name.

pub fn by_index_raw(
    &mut self,
    index: usize
) -> Result<Vec<u8>, ReadCampaignError>

Get a scenario file buffer by its campaign index.

impl<R> Campaign<R> where
    R: Read + Seek, 

pub fn write_to<W>(&mut self, output: &mut W) -> Result<(), WriteCampaignError> where
    W: Write, 

Write the scenario file to an output stream.

Trait Implementations

impl<R> Clone for Campaign<R> where
    R: Clone + Read + Seek, 

fn clone(&self) -> Campaign<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Debug for Campaign<R> where
    R: Debug + Read + Seek, 

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

Formats the value using the given formatter.