Skip to main content

InventoryFile

Struct InventoryFile 

Source
pub struct InventoryFile;
Expand description

Inventory file handler - mirrors Sphinx’s InventoryFile class

Implementations§

Source§

impl InventoryFile

Source

pub fn loads(content: &[u8], uri: &str) -> Result<Inventory>

Load inventory from bytes (mirrors Sphinx’s InventoryFile.loads).

Operates on raw bytes throughout the header framing and the version-2 zlib tail — the compressed payload is never decoded as text, never line-split, until after zlib::decompress succeeds.

Source

pub async fn load<P: AsRef<Path>>(filename: P, uri: &str) -> Result<Inventory>

Load inventory from file

Source

pub async fn dump<P: AsRef<Path>>( path: P, project: &str, version: &str, domains: &[(&str, Vec<InvObject>)], get_target_uri: impl Fn(&str) -> String, ) -> Result<()>

Write inventory to path in Sphinx’s version-2 format (mirrors InventoryFile.dump, inventory.py:174-207).

Decoupled from BuildEnvironment/Builder: callers supply the already-collected per-domain object lists and a get_target_uri closure (Builder.get_target_uri(docname) in Sphinx) instead of live env/builder references.

domains need not be pre-sorted — this sorts domains alphabetically by name and, within each domain, sorts its objects by (name, dispname, objtype, docname, anchor, priority), mirroring env.domains.sorted() + sorted(domain.get_objects()) (inventory.py:194-196).

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.