bdld::DatumBinaryRef Class Reference

#include <bdld_datumbinaryref.h>

List of all members.

Public Types
typedef bsls::Types::size_type	SizeType
Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (DatumBinaryRef, bsl::is_trivially_copyable)
	BSLMF_NESTED_TRAIT_DECLARATION (DatumBinaryRef, bdlb::HasPrintMethod)
	DatumBinaryRef ()
	DatumBinaryRef (const void *data, SizeType size)
	DatumBinaryRef (const DatumBinaryRef &origin)
	~DatumBinaryRef ()
DatumBinaryRef &	operator= (const DatumBinaryRef &rhs)
const void *	data () const
SizeType	size () const
bsl::ostream &	print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const

---

Detailed Description

This class provides a type to represent a pointer to non-modifiable binary data and an integral size value.

See Component bdld_datumbinaryref

---

Member Typedef Documentation

typedef bsls::Types::size_type bdld::DatumBinaryRef::SizeType

---

Constructor & Destructor Documentation

bdld::DatumBinaryRef::DatumBinaryRef

(

)

Create a DatumBinaryRef object having zero data pointer and size.

bdld::DatumBinaryRef::DatumBinaryRef	(	const void *	data,
		SizeType	size
	)

Create a DatumBinaryRef object having the specified data and size. The behavior is undefined unless 0 != data || 0 == size. Note that the memory pointed by data is never accessed by a DatumBinaryRef object.

bdld::DatumBinaryRef::DatumBinaryRef

(

const DatumBinaryRef &

origin

)

bdld::DatumBinaryRef::~DatumBinaryRef

(

)

---

Member Function Documentation

bdld::DatumBinaryRef::BSLMF_NESTED_TRAIT_DECLARATION	(	DatumBinaryRef	,
		bsl::is_trivially_copyable
	)

bdld::DatumBinaryRef::BSLMF_NESTED_TRAIT_DECLARATION	(	DatumBinaryRef	,
		bdlb::HasPrintMethod
	)

DatumBinaryRef& bdld::DatumBinaryRef::operator=

(

const DatumBinaryRef &

rhs

)

const void* bdld::DatumBinaryRef::data

(

)

const

Return the pointer to the non-modifiable binary data.

SizeType bdld::DatumBinaryRef::size

(

)

const

Return the size of the binary data.

bsl::ostream& bdld::DatumBinaryRef::print	(	bsl::ostream &	stream,
		int	level = 0,
		int	spacesPerLevel = 4
	)			const

Write the value of this object to the specified output stream in a human-readable format, and return a reference to the modifyable stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect. Note that this human-readable format is not fully specified, and can change without notice.

---

The documentation for this class was generated from the following file:

• bdld_datumbinaryref.h