Struct BlueprintCodec

pub struct BlueprintCodec;

Utility class which knows how to convert JSON to and from Factorio’s blueprint string format.

Implementations

impl BlueprintCodec

pub fn encode_writer<W, F>(writer: W, inner: F) -> Result<()>

where W: Write, F: FnOnce(ZlibEncoder<&mut Base64Encoder<'_, VersionPrefixWriter<W>>>) -> Result<()>,

writer adaptor which encodes json data to blueprint string format

typically it is more useful to use encode instead, but this method provides some extra flexibility.

pub fn encode<W: Write>(writer: W, container: &Container) -> Result<()>

write the blueprint string to the given writer

pub fn encode_string(container: &Container) -> Result<String>

produce a new owned string containing the blueprint string

pub fn decode_reader<R, F>(reader: R, inner: F) -> Result<()>

where R: Read, F: FnOnce(ZlibDecoder<Base64Decoder<'_, VersionPrefixReader<WhitespaceRemover<R>>>>) -> Result<()>,

reader adaptor which decodes a blueprint string to json

typically it is more useful to use decode instead, but this method gives flexibility in the event that it is required

pub fn decode<R: Read>(reader: R) -> Result<Container>

read the blueprint string from the given reader

pub fn decode_string(blueprint: &str) -> Result<Container>

read the blueprint string from the given input