Microsoft.PSRule.Types.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.PSRule.Types</name>
    </assembly>
    <members>
        <member name="T:PSRule.Data.IDateVersionConstraint">
            <summary>
            An date version constraint.
            </summary>
        </member>
        <member name="M:PSRule.Data.IDateVersionConstraint.Equals(PSRule.Data.DateVersion.Version)">
            <summary>
            Determines if the date version meets the requirments of the constraint.
            </summary>
        </member>
        <member name="T:PSRule.Data.DateVersion">
            <summary>
            A helper for comparing date version strings.
            An date version is represented as YYYY-MM-DD-prerelease.
            </summary>
        </member>
        <member name="T:PSRule.Data.DateVersion.ComparisonOperator">
            <summary>
            A comparison operation for a version constraint.
            </summary>
        </member>
        <member name="F:PSRule.Data.DateVersion.ComparisonOperator.Equals">
            <summary>
            YYYY-MM-DD bits must match.
            </summary>
        </member>
        <member name="T:PSRule.Data.DateVersion.VersionConstraint">
            <summary>
            An date version constraint.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.VersionConstraint.Equals(PSRule.Data.DateVersion.Version)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)">
            <summary>
            Greater Than.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)">
            <summary>
            Less Than.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.ConstraintExpression.PR(PSRule.Data.DateVersion.PR)">
            <summary>
            Compare pre-release.
            </summary>
        </member>
        <member name="T:PSRule.Data.DateVersion.Version">
            <summary>
            An date version.
            </summary>
        </member>
        <member name="F:PSRule.Data.DateVersion.Version.Year">
            <summary>
            The year part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.DateVersion.Version.Month">
            <summary>
            The month part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.DateVersion.Version.Day">
            <summary>
            The day part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.DateVersion.Version.Prerelease">
            <summary>
            The pre-release part of the version.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.ToString">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Object)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.GetHashCode">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.Equals(PSRule.Data.DateVersion.Version)">
            <summary>
            Compare the version against another version.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Int32,System.Int32,System.Int32)">
            <summary>
            Compare the version against another version based on YYYY-MM-DD.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.Version.CompareTo(PSRule.Data.DateVersion.Version)">
            <summary>
            Compare the version against another version.
            </summary>
        </member>
        <member name="T:PSRule.Data.DateVersion.PR">
            <summary>
            An date version pre-release identifier.
            </summary>
        </member>
        <member name="P:PSRule.Data.DateVersion.PR.Value">
            <summary>
            The string value of a pre-release identifier.
            </summary>
        </member>
        <member name="P:PSRule.Data.DateVersion.PR.Stable">
            <summary>
            Is the pre-release identifier empty, indicating a stable release.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.PR.CompareTo(PSRule.Data.DateVersion.PR)">
            <summary>
            Compare the pre-release identifer to another pre-release identifier.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.PR.Equals(System.Object)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.PR.GetHashCode">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.PR.ToString">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.DateVersion.VersionStream.GetJoin">
            <summary>
            1.2.3 || 3.4.5
            >=1.2.3 &lt;3.4.5
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.VersionStream.IsLetter(System.Char)">
            <summary>
            Is the character within the reduced set of allowed characters. a-z or A-Z.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.TryParseConstraint(System.String,PSRule.Data.IDateVersionConstraint@,System.Boolean)">
            <summary>
            Try to parse a version constraint from the provided string.
            </summary>
        </member>
        <member name="M:PSRule.Data.DateVersion.TryParseVersion(System.String,PSRule.Data.DateVersion.Version@)">
            <summary>
            Try to parse a version from the provided string.
            </summary>
        </member>
        <member name="T:PSRule.Data.ModuleConstraint">
            <summary>
            A version constraint for a PSRule module.
            </summary>
        </member>
        <member name="M:PSRule.Data.ModuleConstraint.#ctor(System.String,PSRule.Data.ISemanticVersionConstraint)">
            <summary>
            Create a version constraint for a PSRule module.
            </summary>
            <param name="module">The name of the module.</param>
            <param name="constraint">The version constraint of the module.</param>
        </member>
        <member name="P:PSRule.Data.ModuleConstraint.Module">
            <summary>
            The name of the module.
            </summary>
        </member>
        <member name="P:PSRule.Data.ModuleConstraint.Constraint">
            <summary>
            The version constraint of the module.
            </summary>
        </member>
        <member name="T:PSRule.Data.ISemanticVersionConstraint">
            <summary>
            A semantic version constraint.
            </summary>
        </member>
        <member name="M:PSRule.Data.ISemanticVersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)">
            <summary>
            Determines if the semantic version meets the requirments of the constraint.
            </summary>
        </member>
        <member name="T:PSRule.Data.SemanticVersion">
            <summary>
            A helper for comparing semantic version strings.
            </summary>
        </member>
        <member name="T:PSRule.Data.SemanticVersion.ComparisonOperator">
            <summary>
            A comparison operation for a version constraint.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.Equals">
            <summary>
            Major.Minor.Patch bits must match.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.PatchUplift">
            <summary>
            Major.Minor bits must match, Patch can equal to or greater.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.MinorUplift">
            <summary>
            Major bit must match, Minor.Patch can be equal to or greater.
            </summary>
        </member>
        <member name="T:PSRule.Data.SemanticVersion.VersionConstraint">
            <summary>
            A semantic version constraint.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)">
            <summary>
            Greater Than.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)">
            <summary>
            Less Than.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.PR(PSRule.Data.SemanticVersion.PR)">
            <summary>
            Compare pre-release.
            </summary>
        </member>
        <member name="T:PSRule.Data.SemanticVersion.Version">
            <summary>
            A semantic version.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.Version.Major">
            <summary>
            The major part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.Version.Minor">
            <summary>
            The minor part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.Version.Patch">
            <summary>
            The patch part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.Version.Prerelease">
            <summary>
            The pre-release part of the version.
            </summary>
        </member>
        <member name="F:PSRule.Data.SemanticVersion.Version.Build">
            <summary>
            The build part of the version.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.TryParse(System.String,PSRule.Data.SemanticVersion.Version@)">
            <summary>
            Try to parse a semantic version from a string.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.ToString">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Object)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.GetHashCode">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.Equals(PSRule.Data.SemanticVersion.Version)">
            <summary>
            Compare the version against another version.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Int32,System.Int32,System.Int32)">
            <summary>
            Compare the version against another version based on major.minor.patch.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.Version.CompareTo(PSRule.Data.SemanticVersion.Version)">
            <summary>
            Compare the version against another version.
            </summary>
        </member>
        <member name="T:PSRule.Data.SemanticVersion.PR">
            <summary>
            A semantic version pre-release identifier.
            </summary>
        </member>
        <member name="P:PSRule.Data.SemanticVersion.PR.Value">
            <summary>
            The string value of a pre-release identifier.
            </summary>
        </member>
        <member name="P:PSRule.Data.SemanticVersion.PR.Stable">
            <summary>
            Is the pre-release identifier empty, indicating a stable release.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.PR.CompareTo(PSRule.Data.SemanticVersion.PR)">
            <summary>
            Compare the pre-release identifer to another pre-release identifier.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.PR.Equals(System.Object)">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.PR.GetHashCode">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.PR.ToString">
            <inheritdoc/>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.VersionStream.GetJoin">
            <summary>
            1.2.3 || 3.4.5
            >=1.2.3 &lt;3.4.5
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.VersionStream.IsLetter(System.Char)">
            <summary>
            Is the character within the reduced set of allowed characters. a-z or A-Z.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.TryParseConstraint(System.String,PSRule.Data.ISemanticVersionConstraint@,System.Boolean)">
            <summary>
            Try to parse a version constraint from the provided string.
            </summary>
        </member>
        <member name="M:PSRule.Data.SemanticVersion.TryParseVersion(System.String,PSRule.Data.SemanticVersion.Version@)">
            <summary>
            Try to parse a version from the provided string.
            </summary>
        </member>
    </members>
</doc>