clove.h File Reference

Built-in type that provides readable and writable layers. More...

#include "garlic.h"
#include "allocators.h"
#include "layer.h"

Include dependency graph for clove.h:

Go to the source code of this file.

Typedefs
using	garlic::CloveView = GenericCloveView< CAllocator >
	A view to the a clove value/document conforming to garlic::ViewLayer.
using	garlic::CloveRef = GenericCloveRef< CAllocator >
	A reference to the a clove value/document conforming to garlic::RefLayer.
using	garlic::CloveValue = GenericCloveValue< CAllocator >
	A clove value conforming to garlic::RefLayer.
using	garlic::CloveDocument = GenericCloveDocument< CAllocator >
	A clove document (value) conforming to garlic::RefLayer.

Detailed Description

Built-in type that provides readable and writable layers.

CloveDocument doc;  // contains an allocator for the entire object. (conforms to garlic::RefLayer)
CloveView view = doc.get_view();  // a view to the doc. (conforms to garlic::ViewLayer)
CloveRef ref = doc.get_reference();  // get a reference to the doc. (conforms to garlic::RefLayer)
CloveValue value(doc);  // use the allocator of the document root. (conforms to garlic::RefLayer)