forked from amazon-ion/ion-rust
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds
"experimental-reader" feature (amazon-ion#577)
This PR is the first of a short series that will move the streaming types behind an experimental feature. It is part of issue amazon-ion#576. In this PR, we move the public re-exports of: * `IonReader` * `Reader`/`StreamItem` * `SystemReader`/`SystemStreamItem` * `RawReader`/`RawStreamItem` * `BlockingRawReader` behind the feature flag `"experimental-reader"`. No behavior is changed, and internal modules can continue to access these types as desired.
- Loading branch information
Showing
19 changed files
with
226 additions
and
376 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,166 +1,179 @@ | ||
| use ion_rs::binary::non_blocking::raw_binary_reader::RawBinaryReader; | ||
| use ion_rs::raw_reader::RawStreamItem; | ||
| use ion_rs::result::IonResult; | ||
| use ion_rs::{BlockingRawBinaryReader, IonReader, IonType, RawReader, StreamItem, UserReader}; | ||
| use memmap::MmapOptions; | ||
| use std::fs::File; | ||
| use std::process::exit; | ||
| #[cfg(not(feature = "experimental-reader"))] | ||
| fn main() { | ||
| println!("This example requires the 'experimental-reader' feature to work."); | ||
| } | ||
|
|
||
| fn main() -> IonResult<()> { | ||
| let args: Vec<String> = std::env::args().collect(); | ||
| let mode = args.get(1).unwrap_or_else(|| { | ||
| eprintln!( | ||
| "USAGE:\n\n {} [raw-blocking|raw-nonblocking|user] [Binary Ion file]\n", | ||
| args.get(0).unwrap() | ||
| ); | ||
| eprintln!("No mode was specified."); | ||
| exit(1); | ||
| }); | ||
| let path = args.get(2).unwrap_or_else(|| { | ||
| eprintln!( | ||
| "USAGE:\n\n {} [raw-blocking|raw-nonblocking|user] [Binary Ion file]\n", | ||
| args.get(0).unwrap() | ||
| ); | ||
| eprintln!("No input file was specified."); | ||
| exit(2); | ||
| }); | ||
| let file = File::open(path).unwrap(); | ||
| #[cfg(feature = "experimental-reader")] | ||
| fn main() { | ||
| example::main().unwrap(); | ||
| } | ||
|
|
||
| // This example uses `mmap` so we can use either the blocking reader (which reads from an | ||
| // io::BufRead) or the non-blocking reader (which reads from an AsRef<[u8]>). | ||
| let mmap = unsafe { MmapOptions::new().map(&file).unwrap() }; | ||
| #[cfg(feature = "experimental-reader")] | ||
| mod example { | ||
| use ion_rs::binary::non_blocking::raw_binary_reader::RawBinaryReader; | ||
| use ion_rs::result::IonResult; | ||
| use ion_rs::RawStreamItem; | ||
| use ion_rs::{BlockingRawBinaryReader, IonReader, IonType, RawReader, StreamItem, UserReader}; | ||
| use memmap::MmapOptions; | ||
| use std::fs::File; | ||
| use std::process::exit; | ||
|
|
||
| // Treat the mmap as a byte array. | ||
| let ion_data: &[u8] = &mmap[..]; | ||
| pub fn main() -> IonResult<()> { | ||
| let args: Vec<String> = std::env::args().collect(); | ||
| let mode = args.get(1).unwrap_or_else(|| { | ||
| eprintln!( | ||
| "USAGE:\n\n {} [raw-blocking|raw-nonblocking|user] [Binary Ion file]\n", | ||
| args.get(0).unwrap() | ||
| ); | ||
| eprintln!("No mode was specified."); | ||
| exit(1); | ||
| }); | ||
| let path = args.get(2).unwrap_or_else(|| { | ||
| eprintln!( | ||
| "USAGE:\n\n {} [raw-blocking|raw-nonblocking|user] [Binary Ion file]\n", | ||
| args.get(0).unwrap() | ||
| ); | ||
| eprintln!("No input file was specified."); | ||
| exit(2); | ||
| }); | ||
| let file = File::open(path).unwrap(); | ||
|
|
||
| if mode == "raw-blocking" { | ||
| let mut reader = BlockingRawBinaryReader::new(ion_data)?; | ||
| let number_of_values = read_all_values_raw(&mut reader)?; | ||
| println!("Blocking: read {} values", number_of_values); | ||
| } else if mode == "raw-nonblocking" { | ||
| let mut reader = RawBinaryReader::new(ion_data); | ||
| let number_of_values = read_all_values_raw(&mut reader)?; | ||
| println!("Non-blocking: read {} values", number_of_values); | ||
| } else if mode == "user" { | ||
| let raw_reader = RawBinaryReader::new(ion_data); | ||
| let mut reader = UserReader::new(raw_reader); | ||
| let number_of_values = read_all_values(&mut reader)?; | ||
| println!("Non-blocking: read {} values", number_of_values); | ||
| } else { | ||
| eprintln!("Unsupported `mode`: {}.", mode); | ||
| exit(3); | ||
| } | ||
| // This example uses `mmap` so we can use either the blocking reader (which reads from an | ||
| // io::BufRead) or the non-blocking reader (which reads from an AsRef<[u8]>). | ||
| let mmap = unsafe { MmapOptions::new().map(&file).unwrap() }; | ||
|
|
||
| Ok(()) | ||
| } | ||
| // Treat the mmap as a byte array. | ||
| let ion_data: &[u8] = &mmap[..]; | ||
|
|
||
| // Visits each value in the stream recursively, reading each scalar into a native Rust type. | ||
| // Prints the total number of values read upon completion. | ||
| fn read_all_values_raw<R: RawReader>(reader: &mut R) -> IonResult<usize> { | ||
| use IonType::*; | ||
| use RawStreamItem::{Nothing, Null as NullValue, Value, VersionMarker}; | ||
| let mut count: usize = 0; | ||
| loop { | ||
| match reader.next()? { | ||
| VersionMarker(_major, _minor) => {} | ||
| NullValue(_ion_type) => { | ||
| count += 1; | ||
| continue; | ||
| } | ||
| Value(ion_type) => { | ||
| count += 1; | ||
| match ion_type { | ||
| Struct | List | SExp => reader.step_in()?, | ||
| String => { | ||
| let _string = reader.read_str()?; | ||
| } | ||
| Symbol => { | ||
| let _symbol_id = reader.read_symbol()?; | ||
| } | ||
| Int => { | ||
| let _int = reader.read_i64()?; | ||
| } | ||
| Float => { | ||
| let _float = reader.read_f64()?; | ||
| } | ||
| Decimal => { | ||
| let _decimal = reader.read_decimal()?; | ||
| } | ||
| Timestamp => { | ||
| let _timestamp = reader.read_timestamp()?; | ||
| } | ||
| Bool => { | ||
| let _boolean = reader.read_bool()?; | ||
| } | ||
| Blob => { | ||
| let _blob = reader.read_blob()?; | ||
| } | ||
| Clob => { | ||
| let _clob = reader.read_clob()?; | ||
| if mode == "raw-blocking" { | ||
| let mut reader = BlockingRawBinaryReader::new(ion_data)?; | ||
| let number_of_values = read_all_values_raw(&mut reader)?; | ||
| println!("Blocking: read {} values", number_of_values); | ||
| } else if mode == "raw-nonblocking" { | ||
| let mut reader = RawBinaryReader::new(ion_data); | ||
| let number_of_values = read_all_values_raw(&mut reader)?; | ||
| println!("Non-blocking: read {} values", number_of_values); | ||
| } else if mode == "user" { | ||
| let raw_reader = RawBinaryReader::new(ion_data); | ||
| let mut reader = UserReader::new(raw_reader); | ||
| let number_of_values = read_all_values(&mut reader)?; | ||
| println!("Non-blocking: read {} values", number_of_values); | ||
| } else { | ||
| eprintln!("Unsupported `mode`: {}.", mode); | ||
| exit(3); | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| // Visits each value in the stream recursively, reading each scalar into a native Rust type. | ||
| // Prints the total number of values read upon completion. | ||
| fn read_all_values_raw<R: RawReader>(reader: &mut R) -> IonResult<usize> { | ||
| use IonType::*; | ||
| use RawStreamItem::{Nothing, Null as NullValue, Value, VersionMarker}; | ||
| let mut count: usize = 0; | ||
| loop { | ||
| match reader.next()? { | ||
| VersionMarker(_major, _minor) => {} | ||
| NullValue(_ion_type) => { | ||
| count += 1; | ||
| continue; | ||
| } | ||
| Value(ion_type) => { | ||
| count += 1; | ||
| match ion_type { | ||
| Struct | List | SExp => reader.step_in()?, | ||
| String => { | ||
| let _string = reader.read_str()?; | ||
| } | ||
| Symbol => { | ||
| let _symbol_id = reader.read_symbol()?; | ||
| } | ||
| Int => { | ||
| let _int = reader.read_i64()?; | ||
| } | ||
| Float => { | ||
| let _float = reader.read_f64()?; | ||
| } | ||
| Decimal => { | ||
| let _decimal = reader.read_decimal()?; | ||
| } | ||
| Timestamp => { | ||
| let _timestamp = reader.read_timestamp()?; | ||
| } | ||
| Bool => { | ||
| let _boolean = reader.read_bool()?; | ||
| } | ||
| Blob => { | ||
| let _blob = reader.read_blob()?; | ||
| } | ||
| Clob => { | ||
| let _clob = reader.read_clob()?; | ||
| } | ||
| Null => {} | ||
| } | ||
| Null => {} | ||
| } | ||
| Nothing if reader.depth() > 0 => { | ||
| reader.step_out()?; | ||
| } | ||
| _ => break, | ||
| } | ||
| Nothing if reader.depth() > 0 => { | ||
| reader.step_out()?; | ||
| } | ||
| _ => break, | ||
| } | ||
| Ok(count) | ||
| } | ||
| Ok(count) | ||
| } | ||
|
|
||
| // Visits each value in the stream recursively, reading each scalar into a native Rust type. | ||
| // Prints the total number of values read upon completion. | ||
| fn read_all_values<R: IonReader<Item = StreamItem>>(reader: &mut R) -> IonResult<usize> { | ||
| use IonType::*; | ||
| use StreamItem::{Nothing, Null as NullValue, Value}; | ||
| let mut count: usize = 0; | ||
| loop { | ||
| match reader.next()? { | ||
| NullValue(_ion_type) => { | ||
| count += 1; | ||
| continue; | ||
| } | ||
| Value(ion_type) => { | ||
| count += 1; | ||
| match ion_type { | ||
| Struct | List | SExp => reader.step_in()?, | ||
| String => { | ||
| let _string = reader.read_str()?; | ||
| } | ||
| Symbol => { | ||
| let _symbol_id = reader.read_symbol()?; | ||
| } | ||
| Int => { | ||
| let _int = reader.read_i64()?; | ||
| } | ||
| Float => { | ||
| let _float = reader.read_f64()?; | ||
| } | ||
| Decimal => { | ||
| let _decimal = reader.read_decimal()?; | ||
| } | ||
| Timestamp => { | ||
| let _timestamp = reader.read_timestamp()?; | ||
| } | ||
| Bool => { | ||
| let _boolean = reader.read_bool()?; | ||
| } | ||
| Blob => { | ||
| let _blob = reader.read_blob()?; | ||
| } | ||
| Clob => { | ||
| let _clob = reader.read_clob()?; | ||
| // Visits each value in the stream recursively, reading each scalar into a native Rust type. | ||
| // Prints the total number of values read upon completion. | ||
| fn read_all_values<R: IonReader<Item = StreamItem>>(reader: &mut R) -> IonResult<usize> { | ||
| use IonType::*; | ||
| use StreamItem::{Nothing, Null as NullValue, Value}; | ||
| let mut count: usize = 0; | ||
| loop { | ||
| match reader.next()? { | ||
| NullValue(_ion_type) => { | ||
| count += 1; | ||
| continue; | ||
| } | ||
| Value(ion_type) => { | ||
| count += 1; | ||
| match ion_type { | ||
| Struct | List | SExp => reader.step_in()?, | ||
| String => { | ||
| let _string = reader.read_str()?; | ||
| } | ||
| Symbol => { | ||
| let _symbol_id = reader.read_symbol()?; | ||
| } | ||
| Int => { | ||
| let _int = reader.read_i64()?; | ||
| } | ||
| Float => { | ||
| let _float = reader.read_f64()?; | ||
| } | ||
| Decimal => { | ||
| let _decimal = reader.read_decimal()?; | ||
| } | ||
| Timestamp => { | ||
| let _timestamp = reader.read_timestamp()?; | ||
| } | ||
| Bool => { | ||
| let _boolean = reader.read_bool()?; | ||
| } | ||
| Blob => { | ||
| let _blob = reader.read_blob()?; | ||
| } | ||
| Clob => { | ||
| let _clob = reader.read_clob()?; | ||
| } | ||
| Null => {} | ||
| } | ||
| Null => {} | ||
| } | ||
| Nothing if reader.depth() > 0 => { | ||
| reader.step_out()?; | ||
| } | ||
| _ => break, | ||
| } | ||
| Nothing if reader.depth() > 0 => { | ||
| reader.step_out()?; | ||
| } | ||
| _ => break, | ||
| } | ||
| Ok(count) | ||
| } | ||
| Ok(count) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.