Struct ccsds::Synchronizer

pub struct Synchronizer<'a> {
    pub pattern_hits: HashMap<u8, i32>,
    /* private fields */
}

Synchronizer scans a byte stream for data blocks indicated by a sync marker.

The sync marker may be bit-shifted, in which case the bytes returned will also be bit shifted.

Fields

pattern_hits: HashMap<u8, i32>

Implementations

impl<'a> Synchronizer<'a>

pub fn new( reader: impl Read + Send + 'a, asm: &Vec<u8>, block_size: i32 ) -> Self

pub fn scan(&mut self) -> Result<Option<Loc>>

Scan our stream until the next sync marker is found and return a option containing a [Some(Loc)] indicating the position of the data block and any left bit-shift currently in effect. If there are not enough bytes to check the sync marker return Ok(None).

On ErrorKind::UnexpectedEof this will return [Ok(None)]. Any other error will result in [Err(err)].

pub fn block(&mut self) -> Result<Vec<u8>>

Fetch a block from the stream.

Trait Implementations

impl<'a> IntoIterator for Synchronizer<'a>

type Item = Result<Vec<u8>, Error>

The type of the elements being iterated over.

type IntoIter = BlockIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.