Crate rustvdif

Crate rustvdif 

Source
Expand description

A rust crate for interacting with data encoded in the VLBI Data Interchange Format (VDIF), commonly used in radio astronomy experiments. The VDIF data format is defined in the VDIF specification, found here.

Check out the examples for more information on using this library.

In general, this library assumes that the user has some knowledge of the data stream they are trying to process, as is usually the case for streams of VDIF data. Therefore, much of the functionality of this library depends on the user knowing the size of the incoming VDIF frames in particular, as this massively simplfies the code and improves performance. Wherever the user sees a frame_size parameter, they should assume that this is the size of the frame in bytes including the header.

Modules§

decoding
Functions for decoding VDIF headers and payloads.
encoding
Functions for encoding VDIF headers and payloads.
net
Functionality for sending/receiving VDIF data over a network
utils
A collection of utilities for building applications based on the VDIF data format.

Structs§

VDIFFrame
A VDIF Frame.
VDIFHeader
A VDIF Header.

Functions§

read_frame
Read a VDIF frame from any Read type
read_vtp_frame
Read a VDIF frame from any Read type, along with its VTP sequence number
write_frame
Write a VDIF frame to any Write type
write_vtp_frame
Write a VDIF frame to any Write type, along with a u64 VTP sequence number