io.h File Reference

Classes

class  IoDocument
 

Namespaces

 maxon
 
 maxon::IODOCUMENTSETTINGS
 

Enumerations

enum class  IOFORMAT {
  DEFAULT ,
  BINARY ,
  BINARY_COMPRESSED ,
  JSON ,
  XML ,
  JSON_STABLE
}
 

Functions

enum maxon::IOFORMAT MAXON_ENUM_LIST (IOFORMAT)
 
 MAXON_ATTRIBUTE (Bool, CHECK_CANCELLATION, "net.maxon.iodocument.settings.check_cancellation")
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, Result< void > >::type ReadDocument (const Url &url, const Id &id, T &object, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value !=COLLECTION_KIND::ARRAY &&!STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type ReadDocument (const Url &url, const Id &id, T &object, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type ReadDocument (const Url &url, const Id &id, T &object, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, Result< void > >::type ReadDocument (UrlOrInputStream &&urlOrStream, const Id &id, T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value !=COLLECTION_KIND::ARRAY &&!STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type ReadDocument (UrlOrInputStream &&urlOrStream, const Id &id, T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type ReadDocument (UrlOrInputStream &&urlOrStream, const Id &id, T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
Result< void > WriteDocument (const Url &url, OPENSTREAMFLAGS flags, const Id &id, const T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value==COLLECTION_KIND::ARRAY, Result< void > >::type WriteDocument (const OutputStreamRef &stream, const Id &id, const T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type WriteDocument (const OutputStreamRef &stream, const Id &id, const T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 
template<typename T >
std::enable_if< GetCollectionKind< T >::value !=COLLECTION_KIND::ARRAY &&!STD_IS_REPLACEMENT(same, T, Data), Result< void > >::type WriteDocument (const OutputStreamRef &stream, const Id &id, const T &object, IOFORMAT format=IOFORMAT::DEFAULT, const DataDictionary &dict=DataDictionary())
 

Variables

 DEFAULT
 
 BINARY
 
 BINARY_COMPRESSED
 
 JSON
 
 XML
 
 JSON_STABLE
 

Variable Documentation

◆ DEFAULT

DEFAULT

◆ BINARY

BINARY

◆ BINARY_COMPRESSED

BINARY_COMPRESSED

◆ JSON

JSON

◆ XML

XML

◆ JSON_STABLE

JSON_STABLE

This format is identical to JSON but resolves all references on writing and sorts sets and maps so the order stays stable. JSON_STABLE does not support writing of WeakRefs to COW objects.