Struct HttpRegistry

pub struct HttpRegistry { /* private fields */ }

The http package registry for typst.ts.

Implementations

impl HttpRegistry

pub fn new( cert_path: Option<Arc<Path>>, package_path: Option<Arc<Path>>, package_cache_path: Option<Arc<Path>>, ) -> HttpRegistry

Create a new registry.

pub fn storage(&self) -> &PackageStorage

Get typst-kit implementing package storage

pub fn local_path(&self) -> Option<Arc<Path>>

Get local path option

pub fn paths(&self) -> Vec<Arc<Path>>

Get data & cache dir

pub fn test_package_list( &self, f: impl FnOnce() -> Vec<(PackageSpec, Option<EcoString>)>, )

Set list of packages for testing.

Methods from Deref<Target = PackageStorage>

pub fn package_cache_path(&self) -> Option<&Arc<Path>>

Returns the path at which non-local packages should be stored when downloaded.

pub fn package_path(&self) -> Option<&Arc<Path>>

Returns the path at which local packages are stored.

pub fn prepare_package( &self, spec: &PackageSpec, ) -> Result<Arc<Path>, PackageError>

Make a package available in the on-disk cache.

pub fn determine_latest_version( &self, spec: &VersionlessPackageSpec, ) -> Result<PackageVersion, EcoString>

Try to determine the latest version of a package.

pub fn cached_index(&self) -> Option<&[(PackageSpec, Option<EcoString>)]>

Get the cached package index without network access.

pub fn download_index(&self) -> &[(PackageSpec, Option<EcoString>)]

Download the package index. The result of this is cached for efficiency.

pub fn download_package( &self, spec: &PackageSpec, package_dir: &Path, ) -> Result<(), PackageError>

Download a package over the network.

Panics

Panics if the package spec namespace isn’t preview.

Trait Implementations

impl Default for HttpRegistry

fn default() -> HttpRegistry

Returns the “default value” for a type.

impl Deref for HttpRegistry

type Target = PackageStorage

The resulting type after dereferencing.

fn deref(&self) -> &<HttpRegistry as Deref>::Target

Dereferences the value.

impl PackageRegistry for HttpRegistry

fn resolve(&self, spec: &PackageSpec) -> Result<Arc<Path>, PackageError>

Resolves a package specification to a local path.

fn packages(&self) -> &[(PackageSpec, Option<EcoString>)]

A list of all available packages and optionally descriptions for them.

fn reset(&mut self)

A function to be called when the registry is reset.

fn revision(&self) -> Option<NonZero<usize>>

If the state of package registry can be well-defined by a revision, it should return it. This is used to determine if the compiler should clean and pull the registry again.