Class FlowrDescriptionFile

This decorates a text file and provides access to its content as a DCF (Debian Control File)-like structure.

Hierarchy (View Summary)

Hierarchy-Diagram

UML class diagram of FlowrDescriptionFile

Constructors

constructor

Properties

filePath role?

Methods

from assignRole content loadContent path

Constructors

constructor

Properties

ProtectedfilePath

filePath: PathLike

Optional Readonlyrole

role?: SpecialFileRole

The role of this file, if any, in general your file should not decide for itself what role it has in the project context, this is for the loaders plugins to decide (cf. PluginType) as they can, e.g., respect ignore files, updated mappings, etc. However, they will 1) set this role as soon as they decide on it (using assignRole) and 2) try to respect an already assigned role (however, user configurations may override this).

Methods

Staticfrom

assignRole

content

  • content(): DCF

    The content of the file, this may be cached by the implementation and does not have to be expensive. You can used stream based implementations but right now there is no external, project-wide expressions of life cycles for files. So make sure your implementation closes the resource as soon as possible.

    Returns DCF

ProtectedloadContent

path

  • path(): PathLike

    The path to the file, this is used for identification and logging purposes. If the file does not exist on disk, this can be a virtual path (e.g. for inline files). Even though this is a getter, please make sure that the operation is cheap and deterministic (some decorators may overwrite the path, e.g., because they support other protocols).

    Returns PathLike

Settings

Member Visibility

On This Page

Constructors
Properties
Methods