Struct WriteToFileStageInterfaceProxy#

Struct Documentation#

struct WriteToFileStageInterfaceProxy#

Interface proxy, used to insulate python bindings.

Public Static Functions

static std::shared_ptr<mrc::segment::Object<WriteToFileStage>> init(
mrc::segment::Builder &builder,
const std::string &name,
const std::string &filename,
const std::string &mode = "w",
FileTypes file_type = FileTypes::Auto,
bool include_index_col = true,
bool flush = false
)#

Create and initialize a WriteToFileStage, and return the result.

Parameters:

  • builder – : Pipeline context object reference

  • name – : Name of a stage reference

  • filename – : Reference to the name of the file to which the messages will be written

  • mode – : Reference to the mode for opening a file

  • file_type – : FileTypes

  • include_index_col – : Write out the index as a column, by default true

  • flush – : When true flush the output buffer to disk on each message.

Returns:

std::shared_ptr<mrc::segment::Object<WriteToFileStage>>