VW::io Namespace Reference

Namespaces
	details
	logger

Classes
class	noop_output_streambuf
class	owning_ostream
struct	reader
struct	socket
struct	writer
class	writer_stream_buf

Typedefs
typedef ssize_t(*	write_func_t) (void *context, const char *buffer, size_t num_bytes)

Functions
std::unique_ptr< writer >	open_file_writer (const std::string &file_path)
std::unique_ptr< reader >	open_file_reader (const std::string &file_path)
std::unique_ptr< writer >	open_compressed_file_writer (const std::string &file_path)
std::unique_ptr< reader >	open_compressed_file_reader (const std::string &file_path)
std::unique_ptr< reader >	open_compressed_stdin ()
std::unique_ptr< writer >	open_compressed_stdout ()
std::unique_ptr< reader >	open_stdin ()
std::unique_ptr< writer >	open_stdout ()
std::unique_ptr< writer >	create_custom_writer (void *context, write_func_t write_func)
std::unique_ptr< socket >	wrap_socket_descriptor (int fd)
std::unique_ptr< writer >	create_vector_writer (std::shared_ptr< std::vector< char >> &buffer)
std::unique_ptr< reader >	create_buffer_view (const char *data, size_t len)

Typedef Documentation

typedef ssize_t(* VW::io::write_func_t) (void *context, const char *buffer, size_t num_bytes)

Function Documentation

std::unique_ptr<reader> VW::io::create_buffer_view	(	const char *	data,
		size_t	len
	)

Creates a view over a buffer. This does not take ownership of or copy the buffer. Therefore it is very important the buffer itself outlives this reader object.

Parameters

data	beginning of buffer
len	length of buffer

std::unique_ptr<writer> VW::io::create_custom_writer	(	void *	context,
		write_func_t	write_func
	)

std::unique_ptr<writer> VW::io::create_vector_writer

(

std::shared_ptr< std::vector< char >> &

buffer

)

Parameters

buffer

a shared pointer is required to ensure the buffer remains alive while in use. Passing this in allows callers to retrieve the results of the write operations taken on this buffer.

std::unique_ptr<reader> VW::io::open_compressed_file_reader

(

const std::string &

file_path

)

std::unique_ptr<writer> VW::io::open_compressed_file_writer

(

const std::string &

file_path

)

std::unique_ptr<reader> VW::io::open_compressed_stdin

(

)

std::unique_ptr<writer> VW::io::open_compressed_stdout

(

)

std::unique_ptr<reader> VW::io::open_file_reader

(

const std::string &

file_path

)

std::unique_ptr<writer> VW::io::open_file_writer

(

const std::string &

file_path

)

std::unique_ptr<reader> VW::io::open_stdin

(

)

std::unique_ptr<writer> VW::io::open_stdout

(

)

std::unique_ptr<socket> VW::io::wrap_socket_descriptor

(

int

fd

)

Parameters

fd	the file descriptor of the socket. Will take ownership of the resource.

Returns

socket object which allows creation of readers or writers from this socket