Zero Install .NET API 2.20.0
ZeroInstall.Model.Runner Class Reference

A special kind of dependency: the program that is used to run this one. For example, a Python program might specify Python as its runner. More...

Inheritance diagram for ZeroInstall.Model.Runner:
ZeroInstall.Model.Dependency ZeroInstall.Model.IArgBaseContainer ZeroInstall.Model.Restriction ZeroInstall.Model.IInterfaceUriBindingContainer NanoByte.Common.ICloneable< Dependency > ZeroInstall.Model.FeedElement ZeroInstall.Model.IInterfaceUri NanoByte.Common.ICloneable< Restriction > ZeroInstall.Model.IInterfaceUri ZeroInstall.Model.IBindingContainer ZeroInstall.Model.XmlUnknown

Public Member Functions

override void Normalize ()
 Flattens inheritance structures, Converts legacy elements, sets default values, etc.. More...
 
override string ToString ()
 Returns the runner in the form "Interface (Command)". Not safe for parsing!
 
Runner CloneRunner ()
 Creates a deep copy of this Runner instance. More...
 
override Restriction Clone ()
 Creates a deep copy of this Runner instance. More...
 
bool Equals (Runner? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.Dependency
override bool IsApplicable (Requirements requirements)
 Determines whether this reference is applicable for the given requirements . More...
 
override string ToString ()
 Returns the dependency in the form "Interface (Use)". Not safe for parsing!
 
bool Equals (Dependency? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.Restriction
override string ToString ()
 Returns the dependency in the form "Interface". Not safe for parsing!
 
bool Equals (Restriction? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.FeedElement
override int GetHashCode ()
 
- Public Member Functions inherited from ZeroInstall.Model.XmlUnknown
string ToShortXml ()
 Returns a shortened XML representation (with attributes but without child elements). More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from NanoByte.Common.ICloneable< Restriction >
Restriction Clone ()
 
- Public Member Functions inherited from NanoByte.Common.ICloneable< Dependency >
Dependency Clone ()
 

Properties

string? Command [getset]
 The name of the command in the Restriction.InterfaceUri to use; leave null for Model.Command.NameRun.
 
List< ArgBaseArguments = new() [get]
 A list of command-line arguments to be passed to the runner before the path of the implementation.
 
override string XmlTagName [get]
 
- Properties inherited from ZeroInstall.Model.Dependency
Importance Importance [getset]
 Controls how important this dependency is (i.e. whether ignoring it is an option).
 
string? Use [getset]
 This can be used to indicate that this dependency is only needed in some cases. Deprecated; use Commands instead.
 
List< BindingBindings = new() [get]
 A list of Bindings for Implementations to locate Dependencys.
 
override string XmlTagName [get]
 
- Properties inherited from ZeroInstall.Model.Restriction
FeedUri InterfaceUri = default! [getset]
 The URI or local path used to identify the interface.
 
OS OS [getset]
 Determines for which operating systems this dependency is required.
 
VersionRangeVersions [getset]
 A more flexible alternative to Constraints. Each range is in the form "START..!END". The range matches versions where START <= VERSION < END. The start or end may be omitted. A single version number may be used instead of a range to match only that version, or !VERSION to match everything except that version.
 
string??? InterfaceUriString [getset]
 Used for XML serialization. More...
 
string??? VersionsString [getset]
 Used for XML serialization. More...
 
List< ConstraintConstraints = new() [get]
 A list of version Constraints that must be fulfilled.
 
List< string > Distributions = new() [get]
 Specifies that the selected implementation must be from one of the given distributions (e.g. Debian, RPM). The special value DistributionZeroInstall may be used to require an implementation provided by Zero Install (i.e. one not provided by a PackageImplementation).
 
string DistributionsString [getset]
 Specifies that the selected implementation must be from one of the space-separated distributions (e.g. Debian, RPM). The special value '0install' may be used to require an implementation provided by Zero Install (i.e. one not provided by a PackageImplementation). More...
 
virtual string XmlTagName [get]
 
- Properties inherited from ZeroInstall.Model.FeedElement
VersionRangeIfZeroInstallVersion [getset]
 Only process this element if the current Zero Install version matches the range.
 
string??? IfZeroInstallVersionString [getset]
 Used for XML serialization. More...
 
- Properties inherited from ZeroInstall.Model.IInterfaceUri
FeedUri InterfaceUri [getset]
 An interface URI (URL or file path).
 
- Properties inherited from ZeroInstall.Model.IBindingContainer
List< BindingBindings [get]
 A list of Bindings for Implementations to locate Dependencys.
 
- Properties inherited from ZeroInstall.Model.IArgBaseContainer
List< ArgBaseArguments [get]
 A list of command-line arguments to be passed to an executable.
 

Additional Inherited Members

- Public Attributes inherited from ZeroInstall.Model.XmlUnknown
XmlAttribute?[] UnknownAttributes
 Contains any unknown additional XML attributes.
 
XmlElement?[] UnknownElements
 Contains any unknown additional XML elements.
 
- Static Public Attributes inherited from ZeroInstall.Model.Restriction
const string DistributionZeroInstall = "0install"
 Special value for Distributions that requires require an implementation provided by Zero Install (i.e. one not provided by a PackageImplementation).
 
- Protected Member Functions inherited from ZeroInstall.Model.FeedElement
bool Equals (FeedElement? other)
 
- Protected Member Functions inherited from ZeroInstall.Model.XmlUnknown
void EnsureAttribute (object? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null). More...
 
void EnsureAttributeSafeID (string? value, string attributeName)
 Ensures that a value deserialized from an XML attribute is set (not null) and only contains alphanumeric characters, spaces ( ), dots (.), underscores (_), hyphens (-) and plus signs (+). More...
 
bool Equals (XmlUnknown? other)
 
- Static Protected Member Functions inherited from ZeroInstall.Model.FeedElement
static bool FilterMismatch (IRecipeStep step)
 Checks whether an element passes the specified IfZeroInstallVersion restriction, if any.
 
- Static Package Functions inherited from ZeroInstall.Model.FeedElement
static bool FilterMismatch< T > (T element)
 Checks whether an element passes the specified IfZeroInstallVersion restriction, if any. More...
 

Detailed Description

A special kind of dependency: the program that is used to run this one. For example, a Python program might specify Python as its runner.

See also
Model.Command.Runner

Member Function Documentation

◆ Clone()

override Restriction ZeroInstall.Model.Runner.Clone ( )
virtual

Creates a deep copy of this Runner instance.

Returns
The new copy of the Runner.

Reimplemented from ZeroInstall.Model.Dependency.

◆ CloneRunner()

Runner ZeroInstall.Model.Runner.CloneRunner ( )
inline

Creates a deep copy of this Runner instance.

Returns
The new copy of the Runner.

◆ Normalize()

override void ZeroInstall.Model.Runner.Normalize ( )
inlinevirtual

Flattens inheritance structures, Converts legacy elements, sets default values, etc..

Reimplemented from ZeroInstall.Model.Dependency.


The documentation for this class was generated from the following file: