Change Compact Binary Package API to represent binary attachments as compressed buffers identified by their raw hash.

Change Compact Binary Package serialization for binary attachments to compressed buffers and objects as objects followed by their hash.

Ported changes from Zousar's pending CL17372417

3 files changed, 59 insertions, 15 deletions

diff --git a/zencore/include/zencore/compactbinary.h b/zencore/include/zencore/compactbinary.h
index e20679317..09619be8b 100644
--- a/zencore/include/zencore/compactbinary.h
+++ b/zencore/include/zencore/compactbinary.h
@@ -1096,15 +1096,15 @@ public:
 
 	/** Access the field as an object. Defaults to an empty object on error. */
 	inline CbObject AsObject() &;
-
-	/** Access the field as an object. Defaults to an empty object on error. */
 	inline CbObject AsObject() &&;
 
 	/** Access the field as an array. Defaults to an empty array on error. */
 	inline CbArray AsArray() &;
-
-	/** Access the field as an array. Defaults to an empty array on error. */
 	inline CbArray AsArray() &&;
+
+	/** Access the field as binary. Returns the provided default on error. */
+	inline SharedBuffer AsBinary(const SharedBuffer& Default = SharedBuffer()) &;
+	inline SharedBuffer AsBinary(const SharedBuffer& Default = SharedBuffer()) &&;
 };
 
 /**
@@ -1266,6 +1266,20 @@ CbField::AsArray() &&
 	return IsArray() ? CbArray(AsArrayView(), std::move(*this)) : CbArray();
 }
 
+inline SharedBuffer
+CbField::AsBinary(const SharedBuffer& Default) &
+{
+	const MemoryView View = AsBinaryView();
+	return !HasError() ? SharedBuffer::MakeView(View, GetOuterBuffer()) : Default;
+}
+
+inline SharedBuffer
+CbField::AsBinary(const SharedBuffer& Default) &&
+{
+	const MemoryView View = AsBinaryView();
+	return !HasError() ? SharedBuffer::MakeView(View, std::move(*this).GetOuterBuffer()) : Default;
+}
+
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 /**
diff --git a/zencore/include/zencore/compactbinarypackage.h b/zencore/include/zencore/compactbinarypackage.h
index d60155d1a..57624a3ab 100644
--- a/zencore/include/zencore/compactbinarypackage.h
+++ b/zencore/include/zencore/compactbinarypackage.h
@@ -38,18 +38,27 @@ public:
 	CbAttachment() = default;
 
 	/** Construct a compact binary attachment. Value is cloned if not owned. */
-	inline explicit CbAttachment(const CbObject& Value) : CbAttachment(Value, nullptr) {}
+	inline explicit CbAttachment(const CbObject& InValue) : CbAttachment(InValue, nullptr) {}
 
 	/** Construct a compact binary attachment. Value is cloned if not owned. Hash must match Value. */
-	inline explicit CbAttachment(const CbObject& Value, const IoHash& Hash) : CbAttachment(Value, &Hash) {}
+	inline explicit CbAttachment(const CbObject& InValue, const IoHash& Hash) : CbAttachment(InValue, &Hash) {}
 
-	/** Construct a binary attachment. Value is cloned if not owned. */
-	ZENCORE_API explicit CbAttachment(const SharedBuffer& Value);
+	/** Construct a raw binary attachment. Value is cloned if not owned. */
+	ZENCORE_API explicit CbAttachment(const SharedBuffer& InValue);
 
-	/** Construct a binary attachment. Value is cloned if not owned. Hash must match Value. */
-	ZENCORE_API explicit CbAttachment(const SharedBuffer& Value, const IoHash& Hash);
+	/** Construct a raw binary attachment. Value is cloned if not owned. Hash must match Value. */
+	ZENCORE_API explicit CbAttachment(const SharedBuffer& InValue, const IoHash& Hash);
 
-	/** Construct a binary attachment. Value is cloned if not owned. */
+	/** Construct a raw binary attachment. Value is cloned if not owned. */
+	ZENCORE_API explicit CbAttachment(const CompositeBuffer& InValue);
+
+	/** Construct a raw binary attachment. Value is cloned if not owned. */
+	ZENCORE_API explicit CbAttachment(CompositeBuffer&& InValue);
+
+	/** Construct a raw binary attachment. Value is cloned if not owned. */
+	ZENCORE_API explicit CbAttachment(CompositeBuffer&& InValue, const IoHash& Hash);
+
+	/** Construct a compressed binary attachment. Value is cloned if not owned. */
 	ZENCORE_API explicit CbAttachment(const CompressedBuffer& InValue);
 	ZENCORE_API explicit CbAttachment(CompressedBuffer&& InValue);
 
@@ -66,13 +75,19 @@ public:
 	ZENCORE_API [[nodiscard]] SharedBuffer AsBinary() const;
 
 	/** Access the attachment as compressed binary. Defaults to a null buffer if the attachment is null. */
+	ZENCORE_API [[nodiscard]] CompositeBuffer AsCompositeBinary() const;
+
+	/** Access the attachment as compressed binary. Defaults to a null buffer if the attachment is null. */
 	ZENCORE_API [[nodiscard]] CompressedBuffer AsCompressedBinary() const;
 
 	/** Access the attachment as compact binary. Defaults to a field iterator with no value on error. */
 	ZENCORE_API [[nodiscard]] CbObject AsObject() const;
 
-	/** Returns true if the attachment is either binary or an object */
-	[[nodiscard]] inline bool IsBinary() const { return !IsNull(); }
+	/** Returns true if the attachment is binary */
+	ZENCORE_API [[nodiscard]] bool IsBinary() const;
+
+	/** Returns true if the attachment is compressed binary */
+	ZENCORE_API [[nodiscard]] bool IsCompressedBinary() const;
 
 	/** Returns whether the attachment is an object. */
 	ZENCORE_API [[nodiscard]] bool IsObject() const;
@@ -122,7 +137,19 @@ private:
 		CbObjectValue(CbObject&& InObject, const IoHash& InHash) : Object(std::move(InObject)), Hash(InHash) {}
 	};
 
-	std::variant<CompressedBuffer, CbObjectValue> Value;
+	struct BinaryValue
+	{
+		CompositeBuffer Buffer;
+		IoHash			Hash;
+
+		BinaryValue(const CompositeBuffer& InBuffer) : Buffer(InBuffer.MakeOwned()), Hash(IoHash::HashBuffer(InBuffer)) {}
+		BinaryValue(const CompositeBuffer& InBuffer, const IoHash& InHash) : Buffer(InBuffer.MakeOwned()), Hash(InHash) {}
+		BinaryValue(CompositeBuffer&& InBuffer) : Buffer(std::move(InBuffer)), Hash(IoHash::HashBuffer(Buffer)) {}
+		BinaryValue(CompositeBuffer&& InBuffer, const IoHash& InHash) : Buffer(std::move(InBuffer)), Hash(InHash) {}
+		BinaryValue(SharedBuffer&& InBuffer, const IoHash& InHash) : Buffer(std::move(InBuffer)), Hash(InHash) {}
+	};
+
+	std::variant<nullptr_t, CbObjectValue, BinaryValue, CompressedBuffer> Value;
 };
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
diff --git a/zencore/include/zencore/compactbinaryvalidation.h b/zencore/include/zencore/compactbinaryvalidation.h
index 9799c594a..b1fab9572 100644
--- a/zencore/include/zencore/compactbinaryvalidation.h
+++ b/zencore/include/zencore/compactbinaryvalidation.h
@@ -58,10 +58,13 @@ enum class CbValidateMode : uint32_t
 	Padding = 1 << 3,
 
 	/**
-	 * Validate that a package or attachment has the expected fields and matches its saved hashes.
+	 * Validate that a package or attachment has the expected fields.
 	 */
 	Package = 1 << 4,
 
+	/**
+	 * Validate that a package or attachment matches its saved hashes.
+	 */
 	PackageHash = 1 << 5,
 
 	/** Perform all validation described above. */