MyFavMirrors
/
moonfire-nvr
mirror of https://github.com/scottlamb/moonfire-nvr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix some outdated comments in slices.rs

This commit is contained in:
Scott Lamb 2018-12-28 10:04:47 -06:00
parent 89fa35a2f7
commit 3644548018
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/slices.rs
View File

@ -37,17 +37,18 @@ use futures::Stream;
use std::fmt; use std::fmt;
use std::ops::Range; use std::ops::Range;
/// Writes a byte range to the given `io::Write` given a context argument; meant for use with /// Gets a byte range given a context argument.
/// `Slices`. /// Each `Slice` instance belongs to a single `Slices`.
pub trait Slice : fmt::Debug + Sized + Sync + 'static { pub trait Slice : fmt::Debug + Sized + Sync + 'static {
type Ctx: Send + Clone; type Ctx: Send + Clone;
type Chunk: Send; type Chunk: Send;
/// The byte position (relative to the start of the `Slices`) beyond the end of this slice. /// The byte position (relative to the start of the `Slices`) of the end of this slice,
/// Note the starting position (and thus length) are inferred from the previous slice. /// exclusive. Note the starting position (and thus length) are inferred from the previous
/// slice. Must remain the same for the lifetime of the `Slice`.
fn end(&self) -> u64; fn end(&self) -> u64;
/// Writes `r` to `out`, as in `http_serve::Entity::write_to`. /// Gets the body bytes indicated by `r`, which is relative to this slice's start.
/// The additional argument `ctx` is as supplied to the `Slices`. /// The additional argument `ctx` is as supplied to the `Slices`.
/// The additional argument `l` is the length of this slice, as determined by the `Slices`. /// The additional argument `l` is the length of this slice, as determined by the `Slices`.
fn get_range(&self, ctx: &Self::Ctx, r: Range<u64>, len: u64) fn get_range(&self, ctx: &Self::Ctx, r: Range<u64>, len: u64)
@ -57,7 +58,7 @@ pub trait Slice : fmt::Debug + Sized + Sync + 'static {
} }
/// Helper to serve byte ranges from a body which is broken down into many "slices". /// Helper to serve byte ranges from a body which is broken down into many "slices".
/// This is used to implement `.mp4` serving in `mp4::Mp4File` from `mp4::Slice` enums. /// This is used to implement `.mp4` serving in `mp4::File` from `mp4::Slice` enums.
pub struct Slices<S> where S: Slice { pub struct Slices<S> where S: Slice {
/// The total byte length of the `Slices`. /// The total byte length of the `Slices`.
/// Equivalent to `self.slices.back().map(|s| s.end()).unwrap_or(0)`; kept for convenience and /// Equivalent to `self.slices.back().map(|s| s.end()).unwrap_or(0)`; kept for convenience and
@ -90,7 +91,7 @@ impl<S> Slices<S> where S: Slice {
self.slices.reserve(additional) self.slices.reserve(additional)
} }
/// Appends the given slice, which must have end > the Slice's current len. /// Appends the given slice, which must have end > the Slices's current len.
pub fn append(&mut self, slice: S) -> Result<(), Error> { pub fn append(&mut self, slice: S) -> Result<(), Error> {
if slice.end() <= self.len { if slice.end() <= self.len {
bail!("end {} <= len {} while adding slice {:?} to slices:\n{:?}", bail!("end {} <= len {} while adding slice {:?} to slices:\n{:?}",