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

Make a chosen Implementation available by setting environment variables. More...

Inheritance diagram for ZeroInstall.Model.EnvironmentBinding:
ZeroInstall.Model.Binding ZeroInstall.Model.FeedElement NanoByte.Common.ICloneable< Binding > ZeroInstall.Model.XmlUnknown

Public Member Functions

override void Normalize ()
 Converts legacy elements, sets default values, etc.. More...
 
override string ToString ()
 Returns the binding in the form "Name = Value (Mode, Default)". Not safe for parsing!
 
override Binding Clone ()
 Creates a deep copy of this EnvironmentBinding instance. More...
 
bool Equals (EnvironmentBinding? 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< Binding >
Binding Clone ()
 

Properties

string Name = default! [getset]
 The name of the environment variable.
 
string? Value [getset]
 A static value to set the variable to. More...
 
string? Insert [getset]
 The relative path of the item within the implementation to insert into the variable value. Use . to publish the root directory. More...
 
EnvironmentMode Mode [getset]
 Controls how the Insert or Value is added to the variable.
 
string? Separator [getset]
 Overrides the default separator character (":" on POSIX and ";" on Windows).
 
string? Default [getset]
 If the environment variable is not currently set then this value is used for prepending or appending.
 
- 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...
 

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.
 
- 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

Make a chosen Implementation available by setting environment variables.

Member Function Documentation

◆ Clone()

override Binding ZeroInstall.Model.EnvironmentBinding.Clone ( )
virtual

Creates a deep copy of this EnvironmentBinding instance.

Returns
The new copy of the EnvironmentBinding.

Implements ZeroInstall.Model.Binding.

◆ Normalize()

override void ZeroInstall.Model.EnvironmentBinding.Normalize ( )
virtual

Converts legacy elements, sets default values, etc..

Reimplemented from ZeroInstall.Model.Binding.

Property Documentation

◆ Insert

string? ZeroInstall.Model.EnvironmentBinding.Insert
getset

The relative path of the item within the implementation to insert into the variable value. Use . to publish the root directory.

If this is set Value must be null.

◆ Value

string? ZeroInstall.Model.EnvironmentBinding.Value
getset

A static value to set the variable to.

If this is set Insert must be null.


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