Syntax Reference

cache_new_methods!(env, world_before; get_return_type=false)

For every function-thing with at least one method whose method_world is newer than world_before, call cache_methods(f, name, env, get_return_type; min_world=world_before). The min_world filter inside cache_methods skips pre-existing methods, and the existing _lookup(VarRef(m[1]), env) filter skips methods whose defining module is not represented in env. The caller controls attribution by choosing what env contains.

get_cache_path(manifest, uuid)

Returns a vector containing the cache storage path for a package structured: [folder, folder, file].

get_manifest_candidates(environment_path, version = VERSION)

Return a vector containing manifest candidates if they exist, including version-specific manifests.

get_pkg_path(pkg::Base.PkgId, env, depot_path)

Find out where a package is installed without having to load it.

isinmanifest(context, package::Union{String,UUID})

Checks whether a package is in the manifest of a given context, e.g. is either directly loadable or is a dependency of an loadable package.

isinproject(context, package::Union{String,UUID})

Checks whether a package is in the dependencies of a given context, e.g. is directly loadable.

load_package_from_cache_into_store!(ssp::SymbolServerInstance, uuid, store)

Tries to load the on-disc stored cache for a package (uuid). Attempts to generate (and save to disc) a new cache if the file does not exist or is unopenable.

manifest(c::Pkg.Types.Context)

Retrieves the UUID -> PackageEntry map from the manifest of a Context.

path = maybe_fix_path(path)

Return a normalized, absolute path for a source file path.

path = maybe_fixup_stdlib_path(path::String)

Return path corrected for julia issue #26314 if applicable. Otherwise, return the input path unchanged.

Due to the issue mentioned above, location info for methods defined one of Julia's standard libraries are, for non source Julia builds, given as absolute paths on the worker that built the julia executable. This function corrects such a path to instead refer to the local path on the users drive.

maybe_getfield(k::Symbol , m::ModuleStore, server)

Try to get k from m. This includes: unexported variables, and variables exported by modules used within m.

project(c::Pkg.Types.Context)

Retrieves the project of a Context.

read_manifest(manifest_filename)

Read the manifest from the path and return the UUID -> PackageEntry map. If the file can't be read, return nothing.

remove_non_general_pkgs!(pkgs)

Removes packages that aren't going to be on the symbol cache server because they aren't in the General registry. This avoids leaking private package name & uuid pairs via the url requests to the symbol server.

If the General registry cannot be found packages cannot be checked, so all packages will be removed.

split_module_names(m::Module, allns)

Return two lists of names accessible from calling getfield(m, somename). The first contains those symbols returned by Base.names(m, all = true). The second contains all others, including imported symbols and those introduced by the using of modules.

validate_disc_store(store_path, manifest)

This returns a list of non-jll packages in the manifest that don't have caches on disc.