Struct pmd_flow::FlowData

pub struct FlowData {
    pub unknown1: u32,
    pub unknown2: u16,
    /* private fields */
}

Contain the data obtained from a binary flow file. It is hightly recommended to process it with [FlowDataOutput] if you plan to do high level modification on it.

The file contain a list of dictionaries, and a list of vectors, orderer.

Each entry of the dictionary/vector can be a string or a reference to another dic/vec

Dictionary are indixed by String, Vec by position.

Fields

unknown1: u32

unknown2: u16

Implementations

impl FlowData

pub fn push_dictionary(
    &mut self,
    values: HashMap<String, FlowDataValue>
) -> Result<u16, FlowDataError>

A new dictionary to the FlowData

pub fn push_vector(
    &mut self,
    values: Vec<FlowDataValue>
) -> Result<u16, FlowDataError>

Add a new vector in the FlowData

pub fn dictionary_len(&self) -> usize

return the number of dictionary

pub fn vector_len(&self) -> usize

return the number of vector

pub fn get_dictionary(
    &self,
    dicid: usize
) -> Option<&HashMap<String, FlowDataValue>>

return a reference to a dictionary if it exist, None otherwise

pub fn get_dictionary_mut(
    &mut self,
    dicid: usize
) -> Option<&mut HashMap<String, FlowDataValue>>

return a mutable reference to a dictionary if it exist, None otherwise

pub fn get_vector(&self, vecid: usize) -> Option<&Vec<FlowDataValue>>

return a reference to a vector if it exist, None otherwise.

pub fn get_vector_mut(
    &mut self,
    vecid: usize
) -> Option<&mut Vec<FlowDataValue>>

return a mutable reference to a vector if it exist, None otherwise.

impl FlowData

pub fn new<T: Read + Seek>(file: &mut T) -> Result<FlowData, FlowDataError>

decode a binary flow file

pub fn write<T: Write + Seek>(&self, file: &mut T) -> Result<(), FlowDataError>

encode a binary flow file

note that entry are automatically deduplicated.

Trait Implementations

impl Debug for FlowData

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

Formats the value using the given formatter.

impl Default for FlowData

fn default() -> FlowData

Returns the “default value” for a type.