Struct sea_streamer_file::format::Beacon

pub struct Beacon {
    pub remaining_messages_bytes: u32,
    pub items: Vec<Marker>,
}

Fields

remaining_messages_bytes: u32

items: Vec<Marker>

Implementations

impl Beacon

pub fn empty() -> Self

pub async fn read_from(file: &mut impl ByteSource) -> Result<Self, FileErr>

pub fn write_to(self, sink: &mut impl ByteSink) -> Result<usize, FileErr>

pub fn size(&self) -> usize

pub fn max_markers(space: usize) -> usize

Calculate the maximum number of markers that can be fitted in the given space

pub fn num_markers(beacon_interval: usize) -> usize

The reasonable number of markers to use, given the beacon_interval

Trait Implementations

impl Clone for Beacon

fn clone(&self) -> Beacon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Beacon

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

Formats the value using the given formatter.

impl PartialEq for Beacon

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Beacon

impl StructuralPartialEq for Beacon