XML

C signatures use the C API. See C and C++ bindings for ownership and build instructions. The declarations below come from the generated headers. C++ exposes the same types in namespace fatoora through fatoora/Type.hpp headers.

Serialization and parsing helpers for invoice XML.

FinalizedInvoice serialization

Serialization methods are inherent on FinalizedInvoice; no trait import is needed. Signed invoices expose stored XML through xml() and into_xml() and have no formatting methods.

Migration: remove ToXml imports and replace to_xml_pretty() with to_xml().

to_xml

Serialize to XML

Serialize a finalized invoice with the default two-space indentation.

RustPythonC (FFI)

FinalizedInvoice::to_xml(&self) -> Result<String, InvoiceXmlError>

# use FinalizedInvoice.xml()

#include "fatoora.h"

FatooraStatus fatoora_finalized_invoice_xml(const FatooraFinalizedInvoice *self,
    char **out,
    FatooraError **error);

to_xml_with_format

Serialize with format

Convert to XML with explicit format option.

RustPythonC (FFI)

FinalizedInvoice::to_xml_with_format(&self, format: XmlFormat) -> Result<String, InvoiceXmlError>

# not exposed directly

/* not exposed directly */

FinalizedInvoice

xml

Get finalized invoice XML

RustPythonC (FFI)

FinalizedInvoice::to_xml(&self) -> Result<String, InvoiceXmlError>

FinalizedInvoice.xml() -> str

#include "fatoora.h"

FatooraStatus fatoora_finalized_invoice_xml(const FatooraFinalizedInvoice *self,
    char **out,
    FatooraError **error);

SignedInvoice

Migration: replace Rust signed.to_xml()? with signed.xml() for a borrow or signed.into_xml() to take ownership. In the C API, fatoora_signed_invoice_xml() copies the XML and fatoora_signed_invoice_into_xml() consumes the signed invoice's inner state.

Imported signed invoices retain the exact supplied XML string. Newly signed invoices retain the exact output of signing. Accessors never reformat it. Parsing signed XML does not verify its signature.

Rust xml() borrows the stored string. C fatoora_signed_invoice_xml() and Python xml() return independent copies. C returns owned text through char **out; release it with fatoora_string_free().

xml

Get signed invoice XML

RustPythonC (FFI)

SignedInvoice::xml(&self) -> &str

SignedInvoice.xml() -> str

#include "fatoora.h"

FatooraStatus fatoora_signed_invoice_xml(const FatooraSignedInvoice *self,
    char **out,
    FatooraError **error);

into_xml

Consume the signed invoice and return its exact stored XML. Rust transfers the stored String without copying it. C transfers the result into an owned C string; Python decodes that result into a Python string. C and Python clear the invoice handle, so subsequent access returns an error and closing it remains safe.

SignedInvoice::into_xml(self) -> String

#include "fatoora.h"

FatooraStatus fatoora_signed_invoice_into_xml(FatooraSignedInvoice *self,
    char **out,
    FatooraError **error);

SignedInvoice.into_xml() -> str

parse_finalized_invoice_xml / parse_finalized_invoice_xml_file

parse finalized invoice

Parse finalized invoice XML

RustPythonC (FFI)

parse_finalized_invoice_xml(xml: &str) -> Result<FinalizedInvoice, ParseError>
parse_finalized_invoice_xml_file(path: impl AsRef<Path>) -> Result<FinalizedInvoice, ParseError>

parse_finalized_invoice_xml(xml: str) -> FinalizedInvoice
parse_finalized_invoice_xml_file(path: str) -> FinalizedInvoice

#include "fatoora.h"

FatooraStatus fatoora_finalized_invoice_from_xml(const char *value,
    FatooraFinalizedInvoice **out,
    FatooraError **error);

FatooraStatus fatoora_finalized_invoice_from_file(const char *value,
    FatooraFinalizedInvoice **out,
    FatooraError **error);

parse_signed_invoice_xml / parse_signed_invoice_xml_file

parse signed invoice

Parse signed invoice XML

RustPythonC (FFI)

parse_signed_invoice_xml(xml: &str) -> Result<SignedInvoice, ParseError>
parse_signed_invoice_xml_file(path: impl AsRef<Path>) -> Result<SignedInvoice, ParseError>

parse_signed_invoice_xml(xml: str) -> SignedInvoice
parse_signed_invoice_xml_file(path: str) -> SignedInvoice

#include "fatoora.h"

FatooraStatus fatoora_signed_invoice_from_xml(const char *value,
    FatooraSignedInvoice **out,
    FatooraError **error);

FatooraStatus fatoora_signed_invoice_from_file(const char *value,
    FatooraSignedInvoice **out,
    FatooraError **error);

Types

Types

• XmlFormat selects compact output or explicit indentation for finalized invoices.
• InvoiceXmlError reports serialization failures.
• ParseError reports XML parsing failures and missing/invalid fields.

See also: Validation Guide