Struct BpsvSchema

pub struct BpsvSchema { /* private fields */ }

Represents the complete schema of a BPSV document

Implementations

impl BpsvSchema

pub fn new() -> Self

Create a new empty schema

pub fn parse_header(header_line: &str) -> Result<Self>

Parse schema from a header line

Examples

use ngdp_bpsv::BpsvSchema;

let header = "Region!STRING:0|BuildConfig!HEX:16|BuildId!DEC:4";
let schema = BpsvSchema::parse_header(header)?;

assert_eq!(schema.field_count(), 3);
assert!(schema.has_field("Region"));
assert!(schema.has_field("BuildConfig"));
assert!(schema.has_field("BuildId"));

pub fn add_field( &mut self, name: String, field_type: BpsvFieldType, ) -> Result<()>

Add a field to the schema

pub fn field_count(&self) -> usize

Get the number of fields

pub fn has_field(&self, name: &str) -> bool

Check if a field exists

pub fn get_field(&self, name: &str) -> Option<&BpsvField>

Get a field by name

pub fn get_field_by_index(&self, index: usize) -> Option<&BpsvField>

Get a field by index

pub fn fields(&self) -> &[BpsvField]

Get all fields

pub fn field_names(&self) -> Vec<&str>

Get field names in order

pub fn validate_row(&self, values: &[String]) -> Result<Vec<String>>

Validate a row of values against this schema

pub fn validate_row_refs<'a>(&self, values: &[&'a str]) -> Result<Vec<&'a str>>

Validate a row of string references against this schema (zero-copy)

pub fn to_header_line(&self) -> String

Generate the header line for this schema

Trait Implementations

impl Clone for BpsvSchema

fn clone(&self) -> BpsvSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BpsvSchema

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

Formats the value using the given formatter.

impl Default for BpsvSchema

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BpsvSchema

fn eq(&self, other: &BpsvSchema) -> 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 StructuralPartialEq for BpsvSchema