Introduces Bytes, Blob, and Clob wrapper types
#506
Conversation
This PR introduces new opaque wrappers for `Vec<u8>`, which was used throughout APIs to represent owned blobs and clobs. `Bytes` captures the core functionality of an owned byte array, but does not include Ion type information. `Blob` and `Clob` are both trivial tuple struct wrappers around `Bytes`, adding an Ion type to the data. The `Value::Blob` and `Value::Clob` enum variants (which already provide an Ion type) now wrap an instance of `Bytes`. This PR fixes #500.
| fn read_blob(&mut self) -> IonResult<Vec<u8>> { | ||
| self.read_blob_bytes().map(Vec::from) | ||
| fn read_blob(&mut self) -> IonResult<Blob> { | ||
| self.read_blob_bytes().map(Vec::from).map(Blob::from) |
There was a problem hiding this comment.
🗺️ The IonReader trait's blob- and clob-related methods had to be updated to return Blob and Clob.
Before:
fn read_blob(&mut self) -> IonResult<Vec<u8>>;
fn read_clob(&mut self) -> IonResult<Vec<u8>>;After:
fn read_blob(&mut self) -> IonResult<Blob>;
fn read_clob(&mut self) -> IonResult<Clob>;This change had to be made in each implementation of IonReader, of which there are several.
| } | ||
| } | ||
|
|
||
| impl AsRef<[u8]> for Blob { |
There was a problem hiding this comment.
🗺️ There are a lot of trait impls here that feel repetitive. I'm confident that we can represent them more concisely if needed (perhaps via a macro or a Lob trait with blanket implementations), but I want to leave that for a future PR.
| Blob(Vec<u8>), | ||
| Clob(Vec<u8>), | ||
| Blob(Bytes), | ||
| Clob(Bytes), |
There was a problem hiding this comment.
🗺️ Notice that we can still handle blob and clob values in a single match/if let arm:
if let Blob(b) | Clob(b) = value {
// ...do stuff with `b`...
}| impl From<Blob> for Value { | ||
| fn from(blob: Blob) -> Self { | ||
| let bytes: Bytes = blob.into(); | ||
| Value::Blob(bytes) | ||
| } | ||
| } | ||
|
|
||
| impl From<Clob> for Value { | ||
| fn from(clob: Clob) -> Self { | ||
| let bytes: Bytes = clob.into(); | ||
| Value::Clob(bytes) | ||
| } |
There was a problem hiding this comment.
🗺️ The standalone Blob and Clob types can be trivially widened to Value.
| Clob => Value::Clob(self.reader.read_clob()?.into()), | ||
| Blob => Value::Blob(self.reader.read_blob()?.into()), |
There was a problem hiding this comment.
🗺️ The .into() here is converting the lobs into their inner Bytes representations. From a memory layout perspective, this is a no-op as Bytes is the only field in Blob/Clob.
This PR introduces new opaque wrappers for
Vec<u8>, which was used throughout the APIs to represent owned blobs and clobs.Bytescaptures the core functionality of an owned, immutable byte array, but does not include Ion type information.BlobandClobare both trivial tuple struct wrappers aroundBytes, adding an Ion type to the data.The
Value::BlobandValue::Clobenum variants (which already provide an Ion type) now wrap an instance ofBytes.This PR fixes #500.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.