Skip to main content

Catalog

Struct Catalog 

Source
pub struct Catalog { /* private fields */ }
Expand description

In-memory representation of one or more parsed XML catalog files.

Construct with load_default to use the libxml2-compatible discovery rules, or with [from_files] / [parse] when you know the catalog locations explicitly.

Implementations§

Source§

impl Catalog

Source

pub fn resolve<'a>( &'a self, public_id: Option<&str>, system_id: Option<&str>, ) -> Option<Cow<'a, str>>

Look up a (publicId, systemId) pair against the catalog. Resolution follows OASIS § 7: SYSTEM exact → rewriteSystem → delegateSystem → PUBLIC exact (per prefer) → delegatePublic → nextCatalog chains. Returns the catalog’s URI for the entity, or None if no entry matched anywhere in the chain.

The result is a Cow so direct <public> / <system> matches return a borrow into the catalog (zero allocation) while rewrite entries return the synthesised string owned. Callers that need to own the URI past the catalog’s lifetime can call .into_owned().

Source

pub fn resolve_uri<'a>(&'a self, uri: &str) -> Option<Cow<'a, str>>

<uri> lookup — resolve a generic URI alias. Distinct from <system>: the OASIS spec keeps the two namespaces separate. Used by XInclude / XSLT consumers that want a catalog-style mapping without going through DTD’s PUBLIC/SYSTEM mechanism.

As with resolve, the result is a Cow — direct <uri> matches borrow; <rewriteUri> matches own.

Source

pub fn len(&self) -> usize

Number of entries in the catalog. Counts every entry, including rewrite/delegate/next ones. Used in tests and diagnostics.

Source

pub fn is_empty(&self) -> bool

true if no entries were loaded.

Source

pub fn sources(&self) -> &[PathBuf]

Files this catalog instance was loaded from, in order.

Source

pub fn from_files<P>(paths: &[P]) -> Result<Catalog, XmlError>
where P: AsRef<Path>,

Build a catalog by merging the contents of multiple files. Later entries do NOT override earlier ones — first match wins, matching libxml2’s behaviour for catalog chains.

Source

pub fn parse(bytes: &[u8]) -> Result<Catalog, XmlError>

Parse a catalog from raw bytes. Useful for tests or when the catalog isn’t on disk (embedded resources, etc.).

Trait Implementations§

Source§

impl Clone for Catalog

Source§

fn clone(&self) -> Catalog

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Catalog

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Catalog

Source§

fn default() -> Catalog

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.