Version 結構。

它包含欄位 :major、:minor、:patch、:pre 和 :build，根據 SemVer 2.0，其中 :pre 是清單。

您可以讀取這些欄位，但您不應透過 struct 語法直接建立新的 Version。請改用此模組中的函式。

@spec compare(version(), version()) :: :gt | :eq | :lt

比較兩個版本。

如果第一個版本大於第二個版本，則傳回 :gt，反之則傳回 :lt。如果兩個版本相等，則傳回 :eq。

預先發布版本絕對小於其對應的發布版本。

如果補丁區段是字母數字，則以字元順序比較；否則以數字比較。

忽略建置區段：如果兩個版本僅在建置區段不同，則視為相等。

如果兩個給定的版本中任一個無法解析，則會引發 Version.InvalidVersionError 例外。如果給定已解析的版本，此函式不會引發例外。

範例

iex> Version.compare("2.0.1-alpha1", "2.0.0")
:gt

iex> Version.compare("1.0.0-beta", "1.0.0-rc1")
:lt

iex> Version.compare("1.0.0-10", "1.0.0-2")
:gt

iex> Version.compare("2.0.1+build0", "2.0.1")
:eq

iex> Version.compare("invalid", "2.0.1")
** (Version.InvalidVersionError) invalid version: "invalid"

@spec compile_requirement(Version.Requirement.t()) :: Version.Requirement.t()

將需求編譯成內部表示，這可能會最佳化比對。

內部表示法是不透明的。

@spec match?(version(), requirement(), keyword()) :: boolean()

檢查指定的版本是否符合規範。

如果 version 符合 requirement，則傳回 true，否則傳回 false。如果 requirement 無法解析，則會引發 Version.InvalidRequirementError 例外；如果 version 無法解析，則會引發 Version.InvalidVersionError 例外。如果給定已解析的版本和需求，此函式不會引發例外。

選項

• :allow_pre (布林值) - 當 false 時，預先發布版本不會相符，除非運算元是預先發布版本。預設為 true。有關範例，請參閱上表「需求」區段。

範例

iex> Version.match?("2.0.0", "> 1.0.0")
true

iex> Version.match?("2.0.0", "== 1.0.0")
false

iex> Version.match?("2.1.6-dev", "~> 2.1.2")
true

iex> Version.match?("2.1.6-dev", "~> 2.1.2", allow_pre: false)
false

iex> Version.match?("foo", "== 1.0.0")
** (Version.InvalidVersionError) invalid version: "foo"

iex> Version.match?("2.0.0", "== == 1.0.0")
** (Version.InvalidRequirementError) invalid requirement: "== == 1.0.0"

@spec parse(String.t()) :: {:ok, t()} | :error

將版本字串剖析成 Version 結構。

範例

iex> Version.parse("2.0.1-alpha1")
{:ok, %Version{major: 2, minor: 0, patch: 1, pre: ["alpha1"]}}

iex> Version.parse("2.0-alpha1")
:error

@spec parse!(String.t()) :: t()

將版本字串剖析成 Version。

如果 字串 是無效版本，會引發 Version.InvalidVersionError。

範例

iex> Version.parse!("2.0.1-alpha1")
%Version{major: 2, minor: 0, patch: 1, pre: ["alpha1"]}

iex> Version.parse!("2.0-alpha1")
** (Version.InvalidVersionError) invalid version: "2.0-alpha1"

@spec parse_requirement(String.t()) :: {:ok, Version.Requirement.t()} | :error

將版本需求字串剖析成 Version.Requirement 結構。

範例

iex> {:ok, requirement} = Version.parse_requirement("== 2.0.1")
iex> requirement
Version.parse_requirement!("== 2.0.1")

iex> Version.parse_requirement("== == 2.0.1")
:error

@spec parse_requirement!(String.t()) :: Version.Requirement.t()

將版本需求字串剖析成 Version.Requirement 結構。

如果 字串 是無效需求，會引發 Version.InvalidRequirementError。

範例

iex> Version.parse_requirement!("== 2.0.1")
Version.parse_requirement!("== 2.0.1")

iex> Version.parse_requirement!("== == 2.0.1")
** (Version.InvalidRequirementError) invalid requirement: "== == 2.0.1"

@spec to_string(t()) :: String.t()

將指定的版本轉換成字串。

範例

iex> Version.to_string(%Version{major: 1, minor: 2, patch: 3})
"1.2.3"
iex> Version.to_string(Version.parse!("1.14.0-rc.0+build0"))
"1.14.0-rc.0+build0"