Source code
Revision control
Copy as Markdown
Other Tools
// Copyright (C) 2023, Cloudflare, Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
use crate::QlogSeq;
/// Represents the format of the read event.
#[allow(clippy::large_enum_variant)]
pub enum Event {
/// A native qlog event type.
Qlog(crate::events::Event),
// An extended JSON event type.
Json(crate::events::JsonEvent),
}
/// A helper object specialized for reading JSON-SEQ qlog from a [`BufRead`]
/// trait.
///
pub struct QlogSeqReader {
pub qlog: QlogSeq,
reader: Box<dyn std::io::BufRead + Send + Sync>,
}
impl QlogSeqReader {
pub fn new(
mut reader: Box<dyn std::io::BufRead + Send + Sync>,
) -> Result<Self, Box<dyn std::error::Error>> {
// "null record" skip it
Self::read_record(reader.as_mut());
let header = Self::read_record(reader.as_mut()).ok_or_else(|| {
std::io::Error::new(
std::io::ErrorKind::Other,
"error reading file header bytes",
)
})?;
let res: Result<QlogSeq, serde_json::Error> =
serde_json::from_slice(&header);
match res {
Ok(qlog) => Ok(Self { qlog, reader }),
Err(e) => Err(e.into()),
}
}
fn read_record(
reader: &mut (dyn std::io::BufRead + Send + Sync),
) -> Option<Vec<u8>> {
let mut buf = Vec::<u8>::new();
let size = reader.read_until(b' ', &mut buf).unwrap();
if size <= 1 {
return None;
}
buf.truncate(buf.len() - 1);
Some(buf)
}
}
impl Iterator for QlogSeqReader {
type Item = Event;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
// Attempt to deserialize events but skip them if that fails for any
// reason, ensuring we always read all bytes in the reader.
while let Some(bytes) = Self::read_record(&mut self.reader) {
let r: serde_json::Result<crate::events::Event> =
serde_json::from_slice(&bytes);
if let Ok(event) = r {
return Some(Event::Qlog(event));
}
let r: serde_json::Result<crate::events::JsonEvent> =
serde_json::from_slice(&bytes);
if let Ok(event) = r {
return Some(Event::Json(event));
}
}
None
}
}