Struct BpsvDocument

pub struct BpsvDocument<'a> { /* private fields */ }

Represents a complete BPSV document with borrowed data

Implementations

impl<'a> BpsvDocument<'a>

pub fn new(content: &'a str, schema: BpsvSchema) -> Self

Create a new BPSV document

pub fn parse(content: &'a str) -> Result<Self>

Parse a BPSV document from string content

Examples

use ngdp_bpsv::BpsvDocument;

let content = "Region!STRING:0|BuildId!DEC:4\n## seqn = 12345\nus|1234\neu|5678";

let doc = BpsvDocument::parse(content)?;
assert_eq!(doc.sequence_number(), Some(12345));
assert_eq!(doc.rows().len(), 2);

pub fn schema(&self) -> &BpsvSchema

Get the schema

pub fn sequence_number(&self) -> Option<u32>

Get the sequence number

pub fn set_sequence_number(&mut self, seqn: Option<u32>)

Set the sequence number

pub fn rows(&self) -> &[BpsvRow<'a>]

Get all rows

pub fn rows_mut(&mut self) -> &mut [BpsvRow<'a>]

Get a mutable reference to all rows

pub fn row_count(&self) -> usize

Get the number of rows

pub fn is_empty(&self) -> bool

Check if the document has no data rows

pub fn add_row(&mut self, values: Vec<&'a str>) -> Result<()>

Add a row from raw string slices

pub fn add_typed_row(&mut self, values: Vec<BpsvValue>) -> Result<()>

Add a row from typed values

pub fn get_row(&self, index: usize) -> Option<&BpsvRow<'a>>

Get a row by index

pub fn get_row_mut(&mut self, index: usize) -> Option<&mut BpsvRow<'a>>

Get a mutable row by index

pub fn find_rows_by_field( &self, field_name: &str, value: &str, ) -> Result<Vec<usize>>

Find rows where a field matches a specific value

pub fn to_bpsv_string(&self) -> String

Convert the entire document back to BPSV format

pub fn get_column(&self, field_name: &str) -> Result<Vec<&str>>

Get all values for a specific field

pub fn to_maps(&self) -> Result<Vec<HashMap<String, String>>>

Convert all rows to maps for easier access

pub fn into_owned_rows(self) -> Vec<OwnedBpsvRow>

Convert to owned rows for interning

Trait Implementations

impl<'a> Clone for BpsvDocument<'a>

fn clone(&self) -> BpsvDocument<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BpsvDocument<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for BpsvDocument<'a>

fn eq(&self, other: &BpsvDocument<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for BpsvDocument<'a>