MayaFlux::IO::CompositeWriter Class Reference

Typed writer contract for schema-bearing Composite files. More...

#include <CompositeWriter.hpp>

Inheritance diagram for MayaFlux::IO::CompositeWriter:

Collaboration diagram for MayaFlux::IO::CompositeWriter:

Public Member Functions
virtual bool	can_write (const std::string &filepath) const =0
	Check whether this writer supports the target path.
virtual bool	close ()=0
	Finish the file and release its output stream.
virtual bool	flush ()=0
	Flush buffered output without closing the file.
virtual std::string	get_last_error () const =0
	Get the last writer error.
virtual std::vector< std::string >	get_supported_extensions () const =0
	Get supported file extensions without dots.
virtual bool	is_open () const =0
	Check whether a file is currently open for writing.
virtual bool	open (const std::string &filepath, const Kakshya::CompositeLayout &layout)=0
	Open a new file with the schema all subsequent slices must use.
bool	write (const std::string &filepath, const Kakshya::CompositeArray &array)
	Write a complete array in one call.
virtual bool	write_rows (const Kakshya::CompositeSlice &rows)=0
	Write a bounded slice of elements.
virtual	~CompositeWriter ()=default

Detailed Description

Typed writer contract for schema-bearing Composite files.

A concrete writer chooses a file format and encodes Composite fields without exposing unrestricted byte writes. A file is opened with one layout, then receives one or more bounded slices before close().

Usage:

bool save_measurements(
    CompositeWriter& writer, const Kakshya::CompositeArray& array)
{
    return writer.write("measurements.csv", array);
}

Note

The source array must remain alive throughout each write_rows() call. The writer does not retain the borrowed slice.

Definition at line 27 of file CompositeWriter.hpp.

---

The documentation for this class was generated from the following files:

• CompositeWriter.hpp
• CompositeWriter.cpp