STRUCT

PackageVersion

Contents

• Properties
  • maxSegmentCount
  • major
  • minor
  • patch
  • segment4
  • segment5
  • preReleaseSegments
  • preRelease
  • buildMetadata
  • value
  • description
  • versionCharset
  • lowest
• Methods
  • init(from:)
  • parse(from:)
  • init(_:_:_:_:_:preRelease:buildMetadata:preReleaseSegments:value:)
  • bump()
  • bumpMinor()
  • bumpMajor()
  • ==(_:_:)
  • hash(into:)
  • <(_:_:)

public struct PackageVersion: CustomStringConvertible, Codable, Comparable, Equatable, Hashable

Properties

maxSegmentCount

public static let maxSegmentCount = 5

major

public let major: Int

minor

public let minor: Int

patch

public let patch: Int

segment4

public let segment4: Int

segment5

public let segment5: Int

preReleaseSegments

public let preReleaseSegments: [String]

preRelease

public let preRelease: String?

buildMetadata

public let buildMetadata: String?

value

public let value: String

description

public var description: String

versionCharset

public static let versionCharset: CharacterSet = {
    var charset = CharacterSet.decimalDigits
    charset.insert(charactersIn: ".-+")
    charset.insert(charactersIn: "a"..."z")
    charset.insert(charactersIn: "A"..."Z")
    return charset
}()

lowest

public static let lowest: PackageVersion = .init(0, 0, 0, 0, 1)

Methods

init(from:)

public init(from str: CustomStringConvertible)

parse(from:)

public static func parse(from str: CustomStringConvertible) -> PackageVersion?

init(_:_:_:_:_:preRelease:buildMetadata:preReleaseSegments:value:)

public init(
    _ major: Int,
    _ minor: Int = 0,
    _ patch: Int = 0,
    _ segment4: Int = 0,
    _ segment5: Int = 0,
    preRelease: String? = nil,
    buildMetadata: String? = nil,
    preReleaseSegments: [String] = [],
    value: String? = nil
)

bump()

public func bump() -> Self

bumpMinor()

public func bumpMinor() -> Self

bumpMajor()

public func bumpMajor() -> Self

==(_:_:)

public static func == (lhs: Self, rhs: Self) -> Bool

Parameters

Name	Description
lhs	A value to compare.
rhs	Another value to compare.

hash(into:)

public func hash(into hasher: inout Hasher)

Parameters

Name	Description
hasher	The hasher to use when combining the components of this instance.

<(_:_:)

public static func < (lhs: Self, rhs: Self) -> Bool

Parameters

Name	Description
lhs	A value to compare.
rhs	Another value to compare.