1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
use std::io;
use std::io::Read;
use std::ops::Range;
use delegate::delegate;
use crate::binary::constants::v1_0::IVM;
use crate::constants::v1_0::system_symbol_ids;
use crate::data_source::ToIonDataSource;
use crate::element::{Blob, Clob};
use crate::raw_reader::{RawReader, RawStreamItem};
use crate::raw_symbol_token::RawSymbolToken;
use crate::result::{decoding_error, decoding_error_raw, IonResult};
use crate::stream_reader::IonReader;
use crate::symbol_table::SymbolTable;
use crate::types::{Decimal, Int, Symbol, Timestamp};
use crate::{BlockingRawBinaryReader, BlockingRawTextReader, IonType};
use std::fmt::{Display, Formatter};
use crate::types::Str;
/// Configures and constructs new instances of [Reader].
pub struct ReaderBuilder {}
impl ReaderBuilder {
/// Constructs a [ReaderBuilder] pre-populated with common default settings.
pub fn new() -> ReaderBuilder {
ReaderBuilder {
// Eventually, this will contain settings like a `Catalog` implementation.
}
}
/// Applies the specified settings to a new instance of `Reader`. This process involves
/// reading some data from the beginning of `input` to detect whether its content is
/// text or binary Ion. If this read operation fails, `build` will return an `Err`
/// describing the problem it encountered.
pub fn build<'a, I: 'a + ToIonDataSource>(self, input: I) -> IonResult<Reader<'a>> {
// Convert the provided input into an implementation of `BufRead`
let mut input = input.to_ion_data_source();
// Stack-allocated buffer to hold the first four bytes from input
let mut header: [u8; 4] = [0u8; 4];
// Read up to four bytes of input. This has to be done somewhat manually. Convenience
// functions like `read_exact` will return an error if the input doesn't contain the
// correct number of bytes, and there are legal Ion streams that have fewer than four
// bytes in them. (For example, the stream `1 `.)
let mut total_bytes_read = 0usize;
while total_bytes_read < IVM.len() {
let bytes_read = input.read(&mut header[total_bytes_read..])?;
// If `bytes_read` is zero, we reached the end of the file before we could get
// all four bytes. That means this isn't a (valid) binary stream. We'll assume
// it's text.
if bytes_read == 0 {
// `header` is a stack-allocated buffer that won't outlive this function call.
// If it were full, we could move the whole `[u8; 4]` into the reader. However,
// only some of it is populated and we can't use a slice of it because the array
// is short-lived. Instead we'll make a statically owned copy of the bytes that
// we can move into the reader.
let owned_header = Vec::from(&header[..total_bytes_read]);
// The file was too short to be binary Ion. Construct a text Reader.
return Self::make_text_reader(owned_header);
}
total_bytes_read += bytes_read;
}
// If we've reached this point, we successfully read 4 bytes from the file into `header`.
// Match against `header` to see if it contains the Ion 1.0 version marker.
match header {
[0xe0, 0x01, 0x00, 0xea] => {
// Binary Ion v1.0
let full_input = io::Cursor::new(header).chain(input);
Ok(Self::make_binary_reader(full_input)?)
}
[0xe0, major, minor, 0xea] => {
// Binary Ion v{major}.{minor}
decoding_error(format!(
"cannot read Ion v{major}.{minor}; only v1.0 is supported"
))
}
_ => {
// It's not binary, assume it's text
let full_input = io::Cursor::new(header).chain(input);
Ok(Self::make_text_reader(full_input)?)
}
}
}
fn make_text_reader<'a, I: 'a + ToIonDataSource>(data: I) -> IonResult<Reader<'a>> {
let raw_reader = Box::new(BlockingRawTextReader::new(data)?);
Ok(Reader {
raw_reader,
symbol_table: SymbolTable::new(),
})
}
fn make_binary_reader<'a, I: 'a + ToIonDataSource>(data: I) -> IonResult<Reader<'a>> {
let raw_reader = Box::new(BlockingRawBinaryReader::new(data)?);
Ok(Reader {
raw_reader,
symbol_table: SymbolTable::new(),
})
}
}
impl Default for ReaderBuilder {
fn default() -> Self {
ReaderBuilder::new()
}
}
/// A Reader that uses dynamic dispatch to abstract over the format (text or binary) being
/// read by an underlying [RawReader].
pub type Reader<'a> = UserReader<Box<dyn RawReader + 'a>>;
/// A streaming Ion reader that resolves symbol IDs into their corresponding text.
///
/// Reader itself is format-agnostic; all format-specific logic is handled by the
/// wrapped [RawReader] implementation.
pub struct UserReader<R: RawReader> {
raw_reader: R,
symbol_table: SymbolTable,
}
impl<R: RawReader> UserReader<R> {
pub fn new(raw_reader: R) -> UserReader<R> {
UserReader {
raw_reader,
symbol_table: SymbolTable::new(),
}
}
}
// This module exists to allow our integration tests to directly construct a `UserReader`
// with not-yet-supported settings. We want users to use `ReaderBuilder` instead; eventually,
// `ReaderBuilder` will also work for the integration tests and we can remove this.
// See: https://github.com/amazon-ion/ion-rust/issues/484
#[doc(hidden)]
pub mod integration_testing {
use crate::{RawReader, Reader, UserReader};
pub fn new_reader<'a, R: 'a + RawReader>(raw_reader: R) -> Reader<'a> {
UserReader::new(Box::new(raw_reader))
}
}
/// Stream components that an application-level [Reader] implementation may encounter.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum StreamItem {
/// A non-null Ion value and its corresponding Ion data type.
Value(IonType),
/// A null Ion value and its corresponding Ion data type.
Null(IonType),
/// Indicates that the reader is not positioned over anything. This can happen:
/// * before the reader has begun processing the stream.
/// * after the reader has stepped into a container, but before the reader has called next()
/// * after the reader has stepped out of a container, but before the reader has called next()
/// * after the reader has read the last item in a container
Nothing,
}
impl StreamItem {
/// If `is_null` is `true`, returns `StreamItem::Value(ion_type)`. Otherwise,
/// returns `StreamItem::Null(ion_type)`.
pub fn nullable_value(ion_type: IonType, is_null: bool) -> StreamItem {
if is_null {
StreamItem::Null(ion_type)
} else {
StreamItem::Value(ion_type)
}
}
}
impl Display for StreamItem {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
use StreamItem::*;
match self {
Value(ion_type) => write!(f, "{ion_type}"),
Null(ion_type) => write!(f, "null.{ion_type}"),
Nothing => Ok(()),
}
}
}
impl<R: RawReader> UserReader<R> {
pub fn read_raw_symbol(&mut self) -> IonResult<RawSymbolToken> {
self.raw_reader.read_symbol()
}
pub fn raw_field_name_token(&mut self) -> IonResult<RawSymbolToken> {
self.raw_reader.field_name()
}
fn read_symbol_table(&mut self) -> IonResult<()> {
self.raw_reader.step_in()?;
let mut is_append = false;
let mut new_symbols = vec![];
// It's illegal for a symbol table to have multiple `symbols` or `imports` fields.
// Keep track of whether we've already encountered them.
let mut has_found_symbols_field = false;
let mut has_found_imports_field = false;
loop {
let ion_type = match self.raw_reader.next()? {
RawStreamItem::Value(ion_type) => ion_type,
RawStreamItem::Null(_) => continue,
RawStreamItem::Nothing => break,
RawStreamItem::VersionMarker(major, minor) => {
return decoding_error(format!(
"encountered Ion version marker for v{major}.{minor} in symbol table"
))
}
};
let field_id = self
.raw_reader
.field_name()
.expect("No field ID found inside $ion_symbol_table struct.");
match (field_id, ion_type) {
// The field name is either SID 6 or the text 'imports' and the
// field value is a non-null List
(symbol, IonType::List)
if symbol.matches(system_symbol_ids::IMPORTS, "imports") =>
{
// TODO: SST imports. This implementation only supports local symbol
// table imports and appends.
return decoding_error("importing shared symbol tables is not yet supported");
}
// The field name is either SID 6 or the text 'imports' and the
// field value is a non-null symbol
(symbol, IonType::Symbol)
if symbol.matches(system_symbol_ids::IMPORTS, "imports") =>
{
if has_found_imports_field {
return decoding_error("symbol table had multiple 'imports' fields");
}
has_found_imports_field = true;
let import_symbol = self.raw_reader.read_symbol()?;
if !import_symbol.matches(3, "$ion_symbol_table") {
// Field name `imports` with a symbol other than $ion_symbol_table is ignored
continue;
}
is_append = true;
}
// The field name is either SID 7 or the text 'imports' and the
// field value is a non-null list
(symbol, IonType::List)
if symbol.matches(system_symbol_ids::SYMBOLS, "symbols") =>
{
if has_found_symbols_field {
return decoding_error("symbol table had multiple 'symbols' fields");
}
has_found_symbols_field = true;
self.raw_reader.step_in()?;
loop {
use RawStreamItem::*;
match self.raw_reader.next()? {
Value(IonType::String) => {
new_symbols.push(Some(self.raw_reader.read_string()?));
}
Value(_) | Null(_) => {
// If we encounter a non-string or null, add a placeholder
new_symbols.push(None);
}
VersionMarker(_, _) => {
return decoding_error("Found IVM in symbol table.")
}
Nothing => break,
}
}
self.raw_reader.step_out()?;
}
something_else => {
unimplemented!("No support for {:?}", something_else);
}
}
}
if is_append {
// We're adding new symbols to the end of the symbol table.
for maybe_text in new_symbols.drain(..) {
let _sid = self.symbol_table.intern_or_add_placeholder(maybe_text);
}
} else {
// The symbol table has been set by defining new symbols without importing the current
// symbol table.
self.symbol_table.reset();
for maybe_text in new_symbols.drain(..) {
let _sid = self.symbol_table.intern_or_add_placeholder(maybe_text);
}
}
self.raw_reader.step_out()?;
Ok(())
}
fn raw_annotations(&mut self) -> impl Iterator<Item = RawSymbolToken> + '_ {
// RawReader implementations do not attempt to resolve each annotation into text.
// Additionally, they perform all I/O related to annotations in their implementations
// of Reader::next. As such, it's safe to call `unwrap()` on each raw annotation.
self.raw_reader.annotations().map(|a| a.unwrap())
}
pub fn symbol_table(&self) -> &SymbolTable {
&self.symbol_table
}
}
impl<R: RawReader> IonReader for UserReader<R> {
type Item = StreamItem;
type Symbol = Symbol;
fn current(&self) -> Self::Item {
if let Some(ion_type) = self.ion_type() {
return if self.is_null() {
StreamItem::Null(ion_type)
} else {
StreamItem::Value(ion_type)
};
}
StreamItem::Nothing
}
/// Advances the raw reader to the next user-level Ion value, processing any system-level directives
/// encountered along the way.
// v-- Clippy complains that `next` resembles `Iterator::next()`
#[allow(clippy::should_implement_trait)]
fn next(&mut self) -> IonResult<Self::Item> {
use RawStreamItem::*;
loop {
match self.raw_reader.next()? {
VersionMarker(1, 0) => {
self.symbol_table.reset();
}
VersionMarker(major, minor) => {
return decoding_error(format!(
"Encountered a version marker for v{major}.{minor}, but only v1.0 is supported."
));
}
Value(IonType::Struct) => {
// Top-level structs whose _first_ annotation is $ion_symbol_table are
// interpreted as local symbol tables. Other trailing annotations (if any) are
// ignored. If the first annotation is something other than `$ion_symbol_table`,
// the struct is considered user data even if one of the trailing annotations
// is `$ion_symbol_table`. For more information, see this section of the spec:
// https://amazon-ion.github.io/ion-docs/docs/symbols.html#local-symbol-tables
if self.raw_reader.depth() == 0 {
let is_symtab = match self.raw_reader.annotations().next() {
Some(Err(error)) => return Err(error),
Some(Ok(symbol))
if symbol.matches(
system_symbol_ids::ION_SYMBOL_TABLE,
"$ion_symbol_table",
) =>
{
true
}
_ => false,
};
// This logic cannot be merged into the `match` statement above because
// `self.read_symbol_table()` requires a mutable borrow which is not
// possible while iterating over the reader's annotations.
if is_symtab {
self.read_symbol_table()?;
continue;
}
}
return Ok(StreamItem::Value(IonType::Struct));
}
Value(ion_type) => return Ok(StreamItem::Value(ion_type)),
Null(ion_type) => return Ok(StreamItem::Null(ion_type)),
Nothing => return Ok(StreamItem::Nothing),
}
}
}
fn field_name(&self) -> IonResult<Self::Symbol> {
match self.raw_reader.field_name()? {
RawSymbolToken::SymbolId(sid) => {
self.symbol_table.symbol_for(sid).cloned().ok_or_else(|| {
decoding_error_raw(format!("encountered field ID with unknown text: ${sid}"))
})
}
RawSymbolToken::Text(text) => Ok(Symbol::owned(text)),
}
}
fn annotations<'a>(&'a self) -> Box<dyn Iterator<Item = IonResult<Self::Symbol>> + 'a> {
let iterator = self
.raw_reader
.annotations()
.map(move |raw_token| match raw_token? {
RawSymbolToken::SymbolId(sid) => {
self.symbol_table.symbol_for(sid).cloned().ok_or_else(|| {
decoding_error_raw(format!("found annotation ID with unknown text: ${sid}"))
})
}
RawSymbolToken::Text(text) => Ok(Symbol::owned(text)),
});
Box::new(iterator)
}
fn read_symbol(&mut self) -> IonResult<Self::Symbol> {
match self.raw_reader.read_symbol()? {
RawSymbolToken::SymbolId(symbol_id) => {
if let Some(symbol) = self.symbol_table.symbol_for(symbol_id) {
Ok(symbol.clone())
} else {
decoding_error(format!(
"Found symbol ID ${symbol_id}, which is not defined."
))
}
}
RawSymbolToken::Text(text) => Ok(Symbol::owned(text)),
}
}
// The Reader needs to expose many of the same functions as the Cursor, but only some of those
// need to be re-defined to allow for system value processing. Any method listed here will be
// delegated to self.raw_reader directly.
delegate! {
to self.raw_reader {
fn is_null(&self) -> bool;
fn ion_version(&self) -> (u8, u8);
fn ion_type(&self) -> Option<IonType>;
fn read_null(&mut self) -> IonResult<IonType>;
fn read_bool(&mut self) -> IonResult<bool>;
fn read_int(&mut self) -> IonResult<Int>;
fn read_i64(&mut self) -> IonResult<i64>;
fn read_f32(&mut self) -> IonResult<f32>;
fn read_f64(&mut self) -> IonResult<f64>;
fn read_decimal(&mut self) -> IonResult<Decimal>;
fn read_string(&mut self) -> IonResult<Str>;
fn read_str(&mut self) -> IonResult<&str>;
fn read_blob(&mut self) -> IonResult<Blob>;
fn read_clob(&mut self) -> IonResult<Clob>;
fn read_timestamp(&mut self) -> IonResult<Timestamp>;
fn step_in(&mut self) -> IonResult<()>;
fn step_out(&mut self) -> IonResult<()>;
fn parent_type(&self) -> Option<IonType>;
fn depth(&self) -> usize;
}
}
}
/// Functionality that is only available if the data source we're reading from is in-memory, like
/// a `Vec<u8>` or `&[u8]`.
impl<T: AsRef<[u8]>> UserReader<BlockingRawBinaryReader<io::Cursor<T>>> {
delegate! {
to self.raw_reader {
pub fn raw_bytes(&self) -> Option<&[u8]>;
pub fn raw_field_id_bytes(&self) -> Option<&[u8]>;
pub fn raw_header_bytes(&self) -> Option<&[u8]>;
pub fn raw_value_bytes(&self) -> Option<&[u8]>;
pub fn raw_annotations_bytes(&self) -> Option<&[u8]>;
pub fn field_id_length(&self) -> Option<usize>;
pub fn field_id_offset(&self) -> Option<usize>;
pub fn field_id_range(&self) -> Option<Range<usize>>;
pub fn annotations_length(&self) -> Option<usize>;
pub fn annotations_offset(&self) -> Option<usize>;
pub fn annotations_range(&self) -> Option<Range<usize>>;
pub fn header_length(&self) -> usize;
pub fn header_offset(&self) -> usize;
pub fn header_range(&self) -> Range<usize>;
pub fn value_length(&self) -> usize;
pub fn value_offset(&self) -> usize;
pub fn value_range(&self) -> Range<usize>;
}
}
}
#[cfg(test)]
mod tests {
use std::io;
use super::*;
use crate::binary::constants::v1_0::IVM;
use crate::BlockingRawBinaryReader;
use crate::result::IonResult;
use crate::types::IonType;
use crate::StreamItem::Value;
type TestDataSource = io::Cursor<Vec<u8>>;
// Create a growable byte vector that starts with the Ion 1.0 version marker
fn ion_data(bytes: &[u8]) -> Vec<u8> {
let mut data = Vec::new();
data.extend_from_slice(&IVM);
data.extend_from_slice(bytes);
data
}
// Creates an io::Cursor over the provided data
fn data_source_for(bytes: &[u8]) -> TestDataSource {
let data = ion_data(bytes);
io::Cursor::new(data)
}
// Prepends an Ion 1.0 IVM to the provided data and then creates a BinaryIonCursor over it
fn raw_binary_reader_for(bytes: &[u8]) -> BlockingRawBinaryReader<TestDataSource> {
use RawStreamItem::*;
let mut raw_reader =
BlockingRawBinaryReader::new(data_source_for(bytes)).expect("unable to create reader");
assert_eq!(raw_reader.ion_type(), None);
assert_eq!(raw_reader.next(), Ok(VersionMarker(1, 0)));
assert_eq!(raw_reader.ion_version(), (1u8, 0u8));
raw_reader
}
fn ion_reader_for(bytes: &[u8]) -> Reader {
ReaderBuilder::new().build(ion_data(bytes)).unwrap()
}
const EXAMPLE_STREAM: &[u8] = &[
// $ion_symbol_table::{imports: $ion_symbol_table, symbols: ["foo", "bar", "baz"]}
0xEE, // Var len annotations
0x92, // Annotations + Value length: 21 bytes
0x81, // Annotations length: 1
0x83, // Annotation 3 ('$ion_symbol_table')
0xDE, // Var len struct
0x8E, // Length: 14 bytes
0x87, // Field ID 7 ('symbols')
0xBC, // 12-byte List
0x83, 0x66, 0x6f, 0x6f, // "foo"
0x83, 0x62, 0x61, 0x72, // "bar"
0x83, 0x62, 0x61, 0x7a, // "baz"
// System: {$10: 1, $11: 2, $12: 3}
// User: {foo: 1, bar: 2, baz: 3}
0xD9, // 9-byte struct
0x8A, // Field ID 10
0x21, 0x01, // Integer 1
0x8B, // Field ID 11
0x21, 0x02, // Integer 2
0x8C, // Field ID 12
0x21, 0x03, // Integer 3
];
#[test]
fn test_read_struct() -> IonResult<()> {
let mut reader = ion_reader_for(EXAMPLE_STREAM);
assert_eq!(Value(IonType::Struct), reader.next()?);
reader.step_in()?;
assert_eq!(reader.next()?, Value(IonType::Int));
assert_eq!(reader.field_name()?, "foo");
assert_eq!(reader.next()?, Value(IonType::Int));
assert_eq!(reader.field_name()?, "bar");
assert_eq!(reader.next()?, Value(IonType::Int));
assert_eq!(reader.field_name()?, "baz");
Ok(())
}
}