ndn::io Namespace Reference

Namespaces
	detail

Classes
class	Error

Enumerations
enum	IoEncoding { NO_ENCODING, BASE64, HEX }
	indicates how a file or stream is encoded More...

Functions
optional< Block >	loadBlock (std::istream &is, IoEncoding encoding=BASE64)
	loads a TLV block from a stream More...
void	saveBlock (const Block &block, std::ostream &os, IoEncoding encoding=BASE64)
	saves a TLV block to a stream More...
template<typename T >
shared_ptr< T >	load (std::istream &is, IoEncoding encoding=BASE64)
	loads a TLV element from a stream More...
template<typename T >
shared_ptr< T >	load (const std::string &filename, IoEncoding encoding=BASE64)
	loads a TLV element from a file More...
template<typename T >
void	save (const T &obj, std::ostream &os, IoEncoding encoding=BASE64)
	saves a TLV element to a stream More...
template<typename T >
void	save (const T &obj, const std::string &filename, IoEncoding encoding=BASE64)
	saves a TLV element to a file More...

Enumeration Type Documentation

enum ndn::io::IoEncoding

indicates how a file or stream is encoded

Enumerator
NO_ENCODING	binary without encoding
BASE64	base64 encoding save() inserts a newline after every 64 characters, load() can accept base64 text with or without newlines
HEX	hexadecimal encoding save() uses uppercase letters A-F, load() can accept mixed-case

Definition at line 45 of file io.hpp.

Function Documentation

optional< Block > ndn::io::loadBlock	(	std::istream &	is,
		IoEncoding	encoding = BASE64
	)

loads a TLV block from a stream

Returns

if success, the Block and true otherwise, a default-constructed Block and false

Definition at line 30 of file io.cpp.

References BASE64, ndn::security::transform::base64Decode(), ndn::OBufferStream::buf(), HEX, ndn::security::transform::hexDecode(), NO_ENCODING, ndn::nullopt, ndn::security::transform::streamSink(), and ndn::security::transform::stripSpace().

Referenced by ndn::io::detail::checkInnerError(), and load().

void ndn::io::saveBlock	(	const Block &	block,
		std::ostream &	os,
		IoEncoding	encoding = BASE64
	)

saves a TLV block to a stream

Exceptions

Error

error during saving

Definition at line 63 of file io.cpp.

References BASE64, ndn::security::transform::base64Encode(), HEX, ndn::security::transform::hexEncode(), NO_ENCODING, ndn::Block::size(), ndn::security::transform::streamSink(), and ndn::Block::wire().

Referenced by load(), and save().

template<typename T >

shared_ptr<T> ndn::io::load	(	std::istream &	is,
		IoEncoding	encoding = BASE64
	)

loads a TLV element from a stream

Template Parameters

T	type of TLV element; T must be WireDecodable, and must have a Error nested type

Returns

the TLV element, or nullptr if an error occurs

Definition at line 97 of file io.hpp.

References loadBlock().

template<typename T >

shared_ptr<T> ndn::io::load	(	const std::string &	filename,
		IoEncoding	encoding = BASE64
	)

loads a TLV element from a file

Definition at line 119 of file io.hpp.

References BASE64, and saveBlock().

template<typename T >

void ndn::io::save	(	const T &	obj,
		std::ostream &	os,
		IoEncoding	encoding = BASE64
	)

saves a TLV element to a stream

Template Parameters

T	type of TLV element; T must be WireEncodable, and must have a Error nested type

Exceptions

Error

error during encoding or saving

Definition at line 138 of file io.hpp.

References ndn::io::Error::Error(), and saveBlock().

Referenced by save().

template<typename T >

void ndn::io::save	(	const T &	obj,
		const std::string &	filename,
		IoEncoding	encoding = BASE64
	)

saves a TLV element to a file

Definition at line 158 of file io.hpp.

References save().