operations_research::RecordWriter Class Reference

This class appends a protocol buffer to a file in a binary format. More...

#include <recordio.h>

List of all members.

Public Member Functions
	RecordWriter (File *const file)
template<class P>
bool	WriteProtocolMessage (const P &proto)
bool	Close ()
	Closes the underlying file.
void	set_use_compression (bool use_compression)
Static Public Attributes
static const int	kMagicNumber = 0x3ed7230a
	Magic number when writing and reading protocol buffers.

---

Detailed Description

This class appends a protocol buffer to a file in a binary format.

The data written in the file follows the following format (sequentially):

• MagicNumber (32 bits) to recognize this format.
• Uncompressed data payload size (64 bits)
• Compressed data payload size (64 bits), or 0 if the data is not compressed.
• Payload, possibly compressed. See RecordWriter::Compress() and RecordReader::Uncompress

Definition at line 32 of file recordio.h.

---

Constructor & Destructor Documentation

operations_research::RecordWriter::RecordWriter

(

File *const

file

)

[explicit]

Definition at line 23 of file recordio.cc.

---

Member Function Documentation

template<class P>

bool operations_research::RecordWriter::WriteProtocolMessage

(

const P &

proto

)

[inline]

Definition at line 39 of file recordio.h.

bool operations_research::RecordWriter::Close

(

)

Closes the underlying file.

Definition at line 26 of file recordio.cc.

void operations_research::RecordWriter::set_use_compression

(

bool

use_compression

)

Definition at line 30 of file recordio.cc.

---

Member Data Documentation

const int operations_research::RecordWriter::kMagicNumber = 0x3ed7230a [static]

Magic number when writing and reading protocol buffers.

Definition at line 35 of file recordio.h.

---

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

• or-tools/src/base/recordio.h
• or-tools/src/base/recordio.cc