Struct Parser

pub struct Parser<TResolver = NoOpResolver> { /* private fields */ }

The Parser is responsible for loading and parsing XML Schema documents into a structured Schemas representation.

It supports resolution of schema references such as <import> and <include> using a pluggable Resolver, and can read schema content from strings, files, or URLs.

Internally, the parser maintains a queue of pending schema loads and a cache to prevent duplicate resolutions. Once all schemas are processed, the finish method returns the final Schemas collection.

A generic resolver type TResolver controls how external schemas are fetched. By default, a no-op resolver is used, but file-based or custom resolvers can be injected using with_resolver.

Implementations

impl Parser

pub fn new() -> Self

Create a new Parser instance.

impl<TResolver> Parser<TResolver>

pub fn with_default_resolver(self) -> Parser<FileResolver>

Set the default resolver for this parser.

The default resolver is just a simple FileResolver.

pub fn with_resolver<XResolver: Resolver + 'static>( self, resolver: XResolver, ) -> Parser<XResolver>

Set a custom defined resolver for this parser.

pub fn resolve_includes(self, value: bool) -> Self

Enable or disable resolving includes of parsed XML schemas.

pub fn finish(self) -> Schemas

Finish the parsing process by returning the generated Schemas instance containing all parsed schemas.

impl<TResolver> Parser<TResolver>

where TResolver: Resolver,

pub fn with_default_namespaces(self) -> Self

Add the default namespaces to this parser.

The default namespaces are:

• NamespacePrefix::XS Namespace::XS
• NamespacePrefix::XML Namespace::XML

Errors

Forwards the errors from with_namespace.

pub fn with_namespace( self, prefix: NamespacePrefix, namespace: Namespace, ) -> Self

Add a new namespace to this parser.

This method will add a new namespace to the parser. This can be useful to pre-heat the prefixes for known namespace, or to define namespaces for custom defined types.

This will not add any schema information. It’s just a namespace definition.

Errors

Will return an error if a problem or mismatch with the already existing namespaces was encountered.

impl<TResolver> Parser<TResolver>

where TResolver: Resolver, TResolver::Buffer: BufRead,

pub fn add_schema_from_str( self, schema: &str, ) -> Result<Self, Error<TResolver::Error>>

Add a new XML schema from the passed string.

This will parse the XML schema represented by the provided string and add all schema information to the resulting Schemas structure.

Errors

Will return an suitable error if the parser could not parse the provided schema.

pub fn add_schema_from_reader<R: BufRead>( self, reader: R, ) -> Result<Self, Error<TResolver::Error>>

Add a new XML schema from the passed reader.

This will parse the XML schema represented by the provided reader and add all schema information to the resulting Schemas structure.

Errors

Will return an suitable error if the parser could not read the data from the reader, or parse the schema provided by the reader.

pub fn add_schema_from_file<P: AsRef<Path> + Debug>( self, path: P, ) -> Result<Self, Error<TResolver::Error>>

Add a new XML schema from the passed file path.

This will parse the XML schema represented by the provided filepath and add all schema information to the resulting Schemas structure.

Errors

Will return an suitable error if the parser could not read the data from the file, or parse the schema content.

pub fn add_schema_from_files<I>( self, paths: I, ) -> Result<Self, Error<TResolver::Error>>

where I: IntoIterator + Debug, I::Item: AsRef<Path> + Debug,

Add multiple XML schemas from the passed paths iterator.

Errors

Will return an suitable error if the parser could not read the data from any file, or parse the schema content.

pub fn add_schema_from_url( self, url: Url, ) -> Result<Self, Error<TResolver::Error>>

Add a new XML schema from the passed file url.

This will parse the XML schema represented by the provided url and add all schema information to the resulting Schemas structure.

Errors

Will return an suitable error if the parser could not resolve the URL using the provided resolver or the data from the resolver could not be parsed.

Trait Implementations

impl<TResolver: Debug> Debug for Parser<TResolver>

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

Formats the value using the given formatter.

impl<TResolver: Default> Default for Parser<TResolver>

fn default() -> Parser<TResolver>

Returns the “default value” for a type.