Mirrors/lofty-rs
2
0
Fork 0
mirror of https://github.com/Serial-ATA/lofty-rs synced 2024-11-10 06:34:18 +00:00
Code Issues Projects Releases Packages Wiki Activity

ogg_pager: Remove Page::new

Browse source
This commit is contained in:
Serial 2022-11-26 14:13:37 -05:00 committed by Alex
parent 83e21b63bb
commit cbe865dade
2 changed files with 4 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -21,6 +21,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
spec-compliant and efficient.
- **ogg_pager**: Most fields in `Page` have been separated out into the new `PageHeader` struct.
### Removed
- **ogg_pager**: Removed `Page::new`, now pages can only be created through `ogg_pager::paginate` or
`Packets::paginate`.
## [0.9.0] - 2022-10-30
### Added

42
ogg_pager/src/lib.rs
View file

@ -29,48 +29,6 @@ pub struct Page {
}
impl Page {
/// Create a new `Page`
///
/// This will have the following defaults:
///
/// * `checksum` = 0
/// * `start` = 0
/// * `end` = `content.len()`
///
/// # Errors
///
/// `content.len()` > [`MAX_CONTENT_SIZE`]
///
/// # Example
///
/// ```rust,ignore
/// use ogg_pager::CONTAINS_FIRST_PAGE_OF_BITSTREAM;
///
/// // Creating the identification header
/// let ident_header_packet = vec![...];
/// let stream_serial_number = 2784419176;
///
/// let page = Page::new(
/// CONTAINS_FIRST_PAGE_OF_BITSTREAM,
/// 0,
/// stream_serial_number,
/// ident_header_packet,
/// );
/// ```
pub fn new(header: PageHeader, content: Vec<u8>) -> Result<Self> {
let content_len = content.len();
if content_len > MAX_CONTENT_SIZE {
return Err(PageError::TooMuchData);
}
Ok(Self {
content,
header,
end: content_len as u64,
})
}
/// Returns a reference to the `Page`'s header
pub fn header(&self) -> &PageHeader {
&self.header