VW::io Namespace Reference

Namespaces
	details

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

Typedefs
using	write_func_t = ssize_t(*)(void *, const char *, size_t)

Enumerations
enum	output_location { output_location::out, output_location::err, output_location::compat }
enum	log_level {   log_level::trace = spdlog::level::trace, log_level::debug = spdlog::level::debug, log_level::info = spdlog::level::info, log_level::warn = spdlog::level::warn,   log_level::error = spdlog::level::err, log_level::critical = spdlog::level::critical, log_level::off = spdlog::level::off }

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)
output_location	get_output_location (const std::string &name)
log_level	get_log_level (const std::string &level)
logger	create_default_logger ()
logger	create_null_logger ()
logger	create_custom_sink_logger (void *context, void(*func)(void *, const std::string &))

Typedef Documentation

write_func_t

using VW::io::write_func_t = typedef ssize_t (*)(void*, const char*, size_t)

Enumeration Type Documentation

log_level

enum VW::io::log_level

strong

Enumerator
trace
debug
info
warn
error
critical
off

output_location

enum VW::io::output_location

strong

Enumerator
out
err
compat

Function Documentation

create_buffer_view()

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

create_custom_sink_logger()

logger VW::io::create_custom_sink_logger ( void *  context, void(*)(void *, const std::string &)  func  )

inline

create_custom_writer()

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

create_default_logger()

logger VW::io::create_default_logger ( )

inline

create_null_logger()

logger VW::io::create_null_logger ( )

inline

create_vector_writer()

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.

get_log_level()

log_level VW::io::get_log_level

(

const std::string &

level

)

get_output_location()

output_location VW::io::get_output_location

(

const std::string &

name

)

open_compressed_file_reader()

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

(

const std::string &

file_path

)

open_compressed_file_writer()

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

(

const std::string &

file_path

)

open_compressed_stdin()

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

(

)

open_compressed_stdout()

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

(

)

open_file_reader()

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

(

const std::string &

file_path

)

open_file_writer()

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

(

const std::string &

file_path

)

open_stdin()

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

(

)

open_stdout()

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

(

)

wrap_socket_descriptor()

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