Struct SegmentKey

pub struct SegmentKey {
    pub start_frame_no: u64,
    pub end_frame_no: u64,
    pub timestamp: u64,
}

SegmentKey is used to index segment data, where keys a lexicographically ordered. The scheme is {u64::MAX - start_frame_no}-{u64::MAX - end_frame_no}. With that naming convention, when looking for the segment containing ‘n’, we can perform a prefix search with “{u64::MAX - n}”. The first element of the range will be the biggest segment that contains n if it exists. Beware that if no segments contain n, either the smallest segment not containing n, if n < argmin {start_frame_no}, or the largest segment if n > argmax {end_frame_no} will be returned. e.g:

let mut map = BTreeMap::new();

let meta = SegmentMeta { start_frame_no: 1, end_frame_no: 100 };
map.insert(SegmentKey(&meta).to_string(), meta);

let meta = SegmentMeta { start_frame_no: 101, end_frame_no: 500 };
map.insert(SegmentKey(&meta).to_string(), meta);

let meta = SegmentMeta { start_frame_no: 101, end_frame_no: 1000 };
map.insert(SegmentKey(&meta).to_string(), meta);

map.range(format!("{:020}", u64::MAX - 50)..).next();
map.range(format!("{:020}", u64::MAX - 0)..).next();
map.range(format!("{:020}", u64::MAX - 1)..).next();
map.range(format!("{:020}", u64::MAX - 100)..).next();
map.range(format!("{:020}", u64::MAX - 101)..).next();
map.range(format!("{:020}", u64::MAX - 5000)..).next();

Fields

start_frame_no: u64

end_frame_no: u64

timestamp: u64

Trait Implementations

impl Clone for SegmentKey

fn clone(&self) -> SegmentKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SegmentKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SegmentKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&SegmentMeta> for SegmentKey

fn from(value: &SegmentMeta) -> Self

Converts to this type from the input type.

impl FromStr for SegmentKey

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for SegmentKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SegmentKey

fn eq(&self, other: &SegmentKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SegmentKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SegmentKey

impl Eq for SegmentKey

impl StructuralPartialEq for SegmentKey