upf 0.1.1

Rust library for reading UPF text into typed structs and writing validated UpfData back to UPF
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use std::{
    fs::File,
    io::{BufRead, BufReader},
    path::Path,
};

use crate::{UpfError, model::UpfData};

/// Parse a full UPF document from a string slice.
///
/// This accepts XML-like UPF text and returns a validated [`UpfData`] model.
/// Parsing succeeds only if XML deserialization works and the document passes
/// [`UpfData::validate`].
pub fn from_str(input: &str) -> Result<UpfData, UpfError> {
    let doc: UpfData = quick_xml::de::from_str(input)?;
    doc.validate()?;
    Ok(doc)
}

/// Parse a full UPF document from any buffered reader.
///
/// The entire input is read into memory before deserialization.
pub fn from_reader<R: BufRead>(mut reader: R) -> Result<UpfData, UpfError> {
    let mut xml = String::new();
    reader.read_to_string(&mut xml)?;
    from_str(&xml)
}

/// Parse a UPF document from a filesystem path.
pub fn from_file<P: AsRef<Path>>(path: P) -> Result<UpfData, UpfError> {
    let reader = BufReader::new(File::open(path)?);
    from_reader(reader)
}