Struct TextFSM 

pub struct TextFSM {
    pub parser: TextFSMParser,
    pub curr_state: String,
    pub curr_record: DataRecord,
    pub filldown_record: DataRecord,
    pub records: VecDeque<DataRecord>,
}

The runtime engine for TextFSM parsing.

Fields

parser: TextFSMParser

The underlying compiled parser.

curr_state: String

The current state of the engine.

curr_record: DataRecord

The record currently being populated.

filldown_record: DataRecord

Record containing values to be ‘filled down’ to subsequent records.

records: VecDeque<DataRecord>

List of all successfully parsed records.

Implementations

impl TextFSM

pub fn from_string(content: &str) -> Result<Self>

Creates a new TextFSM instance from a template string.

pub fn from_file<P: AsRef<Path>>(fname: P) -> Result<Self>

Creates a new TextFSM instance from a template file.

pub fn reset(&mut self)

Resets the engine to its initial state, clearing all records and resetting variables. This allows reusing the parsed template for a new file.

pub fn set_curr_state(&mut self, state_name: &str) -> Result<()>

Sets the current state of the engine.

pub fn is_key_value(&self, value_name: &str) -> Option<bool>

pub fn is_filldown_value(&self, value_name: &str) -> Option<bool>

pub fn is_fillup_value(&self, value_name: &str) -> Option<bool>

pub fn is_list_value(&self, value_name: &str) -> Option<bool>

pub fn insert_value_optimized( &self, curr_record: &mut DataRecord, filldown_record: &mut DataRecord, var_info: &CapturedVariable, maybe_value: Option<&str>, aline: &str, ) -> Result<()>

Optimized value insertion into records.

pub fn parse_line(&mut self, aline: &str) -> Result<ParseStatus>

Processes a single line of input against the current state’s rules.

pub fn lowercase_keys(src: &VecDeque<DataRecord>) -> Vec<DataRecord>

Returns a new vector of records with all field names converted to lowercase.

pub fn parse_reader<R: BufRead>(self, reader: R) -> TextFsmIter<R>

Parses input from a reader line-by-line using an iterator. This is memory efficient for large files as it doesn’t buffer all records.

Arguments

• reader - A type implementing BufRead (e.g., BufReader<File>).

pub fn parse_string( &mut self, input: &str, conversion: Option<DataRecordConversion>, ) -> Result<Vec<DataRecord>>

Parses input from a string.

Arguments

• input - The input string to parse.
• conversion - Optional transformation to apply to the results.

pub fn parse_file<P: AsRef<Path>>( &mut self, fname: P, conversion: Option<DataRecordConversion>, ) -> Result<Vec<DataRecord>>

Parses an entire file and returns the extracted records.

Arguments

• fname - Path to the data file to parse.
• conversion - Optional transformation to apply to the results.

Trait Implementations

impl Clone for TextFSM

fn clone(&self) -> TextFSM

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextFSM

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

Formats the value using the given formatter.

impl Default for TextFSM

fn default() -> TextFSM

Returns the “default value” for a type.