Vowpal Wabbit
Public Member Functions | List of all members
VW::io::writer Struct Referenceabstract

#include <io_adapter.h>

Public Member Functions

 writer ()=default
 
virtual ~writer ()=default
 
virtual ssize_t write (const char *buffer, size_t num_bytes)=0
 
virtual void flush ()
 Writers may implement flush - by default is a noop. More...
 
 writer (writer &other)=delete
 
writeroperator= (writer &other)=delete
 
 writer (writer &&other)=delete
 
writeroperator= (writer &&other)=delete
 

Constructor & Destructor Documentation

VW::io::writer::writer ( )
default
virtual VW::io::writer::~writer ( )
virtualdefault
VW::io::writer::writer ( writer other)
delete
VW::io::writer::writer ( writer &&  other)
delete

Member Function Documentation

virtual void VW::io::writer::flush ( )
inlinevirtual

Writers may implement flush - by default is a noop.

writer& VW::io::writer::operator= ( writer other)
delete
writer& VW::io::writer::operator= ( writer &&  other)
delete
virtual ssize_t VW::io::writer::write ( const char *  buffer,
size_t  num_bytes 
)
pure virtual

Write num_bytes of bytes from buffer into this writer

Parameters
bufferbuffer to write from
num_bytesnumber of bytes of buffer to write. buffer must be at least this large otherwise this is undefined behavior.
Returns
the number of bytes successfully written

The documentation for this struct was generated from the following file: