This release adds a lot of documentation examples and tests as well as some breaking changes when manipulating payload data
- Added a new
model::section::PacketTime
enum to represent payload packet time - Added a new
model::section::GenericSection::time
method to get the timestamp of a payload packet - Added a new
model::section::GenericSection::params
method to get the parameters of a packet - Added
--start-time
and--end-time
filter tololrofl analyze
command-line
- Changed the signature of
Rofl::segment_iter
anditer::PayloadIterator::new
to accept an additional boolean parameter to parse payload data (true
) or only headers (false
)
- Fixed
GenericSection::from_slice
to ensure it would work on arbitrary packets
This release features a lot of cleanup in the public API as well as huge design changes in the way data is loaded and stored. This should be treated as a completely different version from 0.1.0.
A notable naming convention change is the replacement of the segment data
label by section
. This change is reflected in structs names.
- Added a
Rofl::segment_iter
method to iterate over the segments of a file - Added a
iter::PayloadIterator
construct to iterate over the segments of a payload
- Moved most structural classes from the crate's root to the
model
subscope. - Moved
SegmentIterator
toiter::SegmentIterator
. Theiter
subscope will contain all future iterators - Moved
error::Errors
to the crate's root (Errors
) - Moved and renamed
segments::SegmentDataCore
tomodel::section::SectionCore
- Moved and renamed
segments::GenericDataSegment
tomodel::section::GenericSection
- Many changes to the public interface of
Rofl
:- Dropped ALL
load_*
methods. Getters are now the only way to access an object - Renamed
meta
tometadata
. Changed the method's return value to aResult<&str, Errors>
- Changed the
payload
function's return value to aResult<Payload, Errors>
- Changed
from_slice
's signature to only need a slice (dropped theconfig
parameter) - Removed the
chunks
andkeyframes
functions. The replacement for those issegment_iter
- Dropped ALL
- Removed the
consts
subscope as the values it held were not of use anymore - Removed the
segments::StartSegment
construct as it could not be used. Future versions should bring back an equivalent
- The
payload
feature may now be disabled without issues. Disabling it will make it impossible to load segment data withiniter::PayloadIterator
Initial unstable release