Struct FrameDecoder

pub struct FrameDecoder { /* private fields */ }

Decodes CADU bytes into Frames.

Examples

Default decode using default CCSDS derandomization and reed-solomon.

use ccsds::framing::decode_frames_rs;

const cadu_len: usize = 1020;
let reed_solomon_interleave = 4;
let blocks: Vec<Vec<u8>> = vec![
  vec![0u8; cadu_len],
];
let frames = decode_frames_rs(blocks.into_iter(), reed_solomon_interleave)
    .filter_map(Result::ok);

Manually specified decode using default CCSDS derandomization and reed-solomon.

use ccsds::framing::{FrameDecoder, DefaultReedSolomon, DefaultDerandomizer};
const cadu_len: usize = 1020;
let reed_solomon_interleave = 4;
let blocks: Vec<Vec<u8>> = vec![
  vec![0u8; cadu_len],
];
let frames = FrameDecoder::new()
    .with_integrity(Box::new(DefaultReedSolomon::new(reed_solomon_interleave)))
    .with_derandomization(Box::new(DefaultDerandomizer))
    .decode(blocks.into_iter())
    .filter_map(Result::ok);

Implementations

impl FrameDecoder

pub fn new() -> Self

pub fn with_derandomization(self, derandomizer: Box<dyn Derandomizer>) -> Self

Apply derandomization using the provided algorithm. If not provided no derandomization is performed.

pub fn with_integrity(self, integrity: Box<dyn IntegrityAlgorithm>) -> Self

Perform integrity checking with the give algorithm. If not provided, no configuration checking is performed.

pub fn with_integrity_threads(self, num: u32) -> Self

Use this number of threads for integrity checks. By default the number of threads is configured automatically and is typically the number of CPUs available on the system.

pub fn decode<B>(self, cadus: B) -> impl Iterator<Item = Result<DecodedFrame>>

where B: Iterator<Item = Vec<u8>> + Send + 'static,

Returns an interator that performs the decode, including derandomization and integrity checks, if configured.

Integrity checks are not performed on VCDU fill frames (vcid=63), however, fill frames are not filtered and are produced by the returned iterator.

Integrity checking is handled in parallel with a distinct job per-CADU using an automatically configured number of threads by default, otherwise the number of threads set using Self::with_integrity_threads.

Errors

Error if integrity checking is used and fails.

Trait Implementations

impl Default for FrameDecoder

fn default() -> FrameDecoder

Returns the “default value” for a type.