Syntax Reference

SymbolServer.get_cache_pathMethod
get_cache_path(manifest, uuid)

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

source
SymbolServer.isinmanifestFunction
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.

source
SymbolServer.isinprojectFunction
isinproject(context, package::Union{String,UUID})

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

source
SymbolServer.load_package_from_cache_into_store!Function
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.

source
SymbolServer.manifestMethod
manifest(c::Pkg.Types.Context)

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

source
SymbolServer.maybe_fixup_stdlib_pathMethod
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.

source
SymbolServer.maybe_getfieldMethod
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.

source
SymbolServer.read_manifestMethod
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.

source
SymbolServer.remove_non_general_pkgs!Method
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.

source
SymbolServer.split_module_namesMethod
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.

source