Struct CRWriter 

pub struct CRWriter {
    pub file: File,
    pub file_path: String,
    pub pkts_per_file: usize,
    pub mbytes_per_file: usize,
    pub file_name: String,
    pub run_id: u32,
    pub file_timestamp: Option<String>,
    pub first_gcu_timestamp: Option<u64>,
    pub file_len_gcu_sec: Option<u32>,
    /* private fields */
}

Write CRFrames (“caraspace frames”) to disk.

A frame can hold any TOF/TelemetryPacket. Data are written to disk in sequential matter, where frames can be added one at a time and buffered for efficient writing

---

How to create a new CRWriter (python)

Arguments

• file_path (str) : Path to store the file under
• run_id (u32) : Run ID for this file (will be written in filename)
• subrun_id (u32) : Sub-Run ID for this file (will be written in filename. If None, a generic “0” will be used
• timestamp (str) : The writer will add an automatic timestamp to the current file based on the current time. This option allows to overwrite that behaviour
• file_len_gcu_sec (u32) : If not None, this will use the gcu time from added packets as the timestamp in the filename, and will write a new file every given number of seconds

Fields

file: File

file_path: String

location to store the file

pkts_per_file: usize

The maximum number of packets for a single file. Ater this number is reached, a new file is started.

mbytes_per_file: usize

The maximum number of (Mega)bytes per file. After this a new file is started

file_name: String

the name of the current file we are writing to

run_id: u32

file_timestamp: Option<String>

it can also take a timestamp, in case we don’t want to use the current time when the file is written

first_gcu_timestamp: Option<u64>

if writing a new file every gcu seconds, keep the first gcutimestamp

file_len_gcu_sec: Option<u32>

Write a new file every gcu seconds (from telemetry packet header)

Implementations

impl CRWriter

pub fn new( file_path: String, run_id: u32, subrun_id: Option<u64>, timestamp: Option<String>, file_len_gcu_sec: Option<u32>, ) -> Self

Instantiate a new PacketWriter

Arguments

• file_path : Path to store the file under
• run_id : Run ID for this file (will be written in filename)
• subrun_id : Sub-Run ID for this file (will be written in filename. If None, a generic “0” will be used
• timestamp : The writer will add an automatic timestamp to the current file based on the current time. This option allows to overwrite that behaviour
• file_len_gcu_sec : If not None, this will use the gcu time from added packets as the timestamp in the filename, and will write a new file every given number of seconds

pub fn get_file(&self, timestamp: Option<String>) -> File

pub fn add_frame(&mut self, frame: &CRFrame)

Induce serialization to disk for a CRFrame

Trait Implementations

impl Default for CRWriter

fn default() -> Self

Returns the “default value” for a type.

impl Display for CRWriter

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

Formats the value using the given formatter.