Pod
const class Pod : Obj
Pod represents a module of Types. Pods serve as a type namespace as well as unit of deployment and versioning.
Always return name()
List of all the defined types
Get the declared list of dependencies for this pod
Return the log for this pod's name
Order a list of pods by their dependencies
Get a list of all the pods installed
Convenience for Env.locale using Locale.cur
Find a type by name
Uri for this pod which is always "fan://{name}"
Version number for this pod
Convenience for Env.props
Look up a resource file in this pod
Load a pod into memory from the specified input stream
Find a pod by name
Get the meta name/value pairs for this pod
Get the pod of the given instance which is convenience for Type.of(obj).pod
Simple name of the pod such as "sys"
Return the fandoc chapter for this pod or null if not available
List all the resource files contained by this pod
Expand a set of pods to include all their recursive dependencies
Convenience for Env.config
Str? config(Str name, Str? def)
Convenience for Env.config.
Depend[] depends()
Get the declared list of dependencies for this pod.
Str? doc()
Return the fandoc chapter for this pod or null if not available. To get the summary string for the pod use:
pod.meta["pod.summary"]
File? file(Uri uri, Bool checked)
Look up a resource file in this pod. The URI must start with the Pod's uri or be path absolute. If the file cannot be found then return null or throw UnresolvedErr based on checked flag.
Examples:
Pod.find("icons").file(`/x16/cut.png`)
Pod.find("icons").file(`fan://icons/x16/cut.png`)
`fan://icons/x16/cut.png`.get
File[] files()
List all the resource files contained by this pod. Resources are any files included in the pod's zip file excluding fcode files. The URI of these files is rooted by uri. Use file or Uri.get to lookup a resource file.
static Pod? find(Str name, Bool checked)
Find a pod by name. If the pod doesn't exist and checked is false then return null, otherwise throw UnknownPodErr.
static Pod[] flattenDepends(Pod[] pods)
Expand a set of pods to include all their recursive dependencies. This method does not order them; see orderByDepends.
static Pod[] list()
Get a list of all the pods installed. Note that currently this method will load all of the pods into memory, so it is an expensive operation.
static Pod load(InStream in)
Load a pod into memory from the specified input stream. The stream must contain a valid pod zip file with all the definitions. The pod is completely loaded into memory and the input stream is closed. The pod cannot have resources. The pod name as defined by /pod.def must be uniquely named or Err is thrown.
Str? locale(Str name, Str? def)
Convenience for Env.locale using Locale.cur.
Log log()
Return the log for this pod's name. This is a convenience for Log.get(name).
Str:Str meta()
Get the meta name/value pairs for this pod. See docLang.
Str name()
Simple name of the pod such as "sys".
static Pod? of(Obj obj)
Get the pod of the given instance which is convenience for Type.of(obj).pod. See Type.pod.
static Pod[] orderByDepends(Pod[] pods)
Order a list of pods by their dependencies. This method does not flatten dependencies - see flattenDepends.
Str:Str props(Uri uri, Duration maxAge)
Convenience for Env.props.
virtual Str toStr()
Always return name().
Type? type(Str name, Bool checked)
Find a type by name. If the type doesn't exist and checked is false then return null, otherwise throw UnknownTypeErr.
Type[] types()
List of all the defined types.
Uri uri()
Uri for this pod which is always "fan://{name}".
Version version()
Version number for this pod.