View Source AntikytheraCore.Version.History.Entry (antikythera v0.5.1)

Summary

Functions

Type-aware getter for canary_target_hosts.

Type-aware setter for canary_target_hosts.

Type-aware getter for installable_until.

Type-aware setter for installable_until.

Creates a new instance of AntikytheraCore.Version.History.Entry by using the given dict.

A variant of new/1 which returns t or raise if validation fails.

Type-aware getter for noupgrade.

Type-aware setter for noupgrade.

Updates an existing instance of AntikytheraCore.Version.History.Entry with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Checks if the given value belongs to t/0 or not.

Type-aware getter for version.

Type-aware setter for version.

Types

@type t() :: %AntikytheraCore.Version.History.Entry{
  canary_target_hosts:
    Croma.TypeGen.Nilable.Croma.TypeGen.ListOf.Croma.String.t(),
  installable_until: Croma.TypeGen.Nilable.Antikythera.Time.t(),
  noupgrade: Croma.Boolean.t(),
  version: Antikythera.VersionStr.t()
}

Functions

@spec canary?(t()) :: boolean()
Link to this function

canary_target_hosts(entry)

View Source
@spec canary_target_hosts(t()) ::
  Croma.TypeGen.Nilable.Croma.TypeGen.ListOf.Croma.String.t()

Type-aware getter for canary_target_hosts.

Link to this function

canary_target_hosts(s, field)

View Source
@spec canary_target_hosts(
  t(),
  Croma.TypeGen.Nilable.Croma.TypeGen.ListOf.Croma.String.t()
) :: t()

Type-aware setter for canary_target_hosts.

@spec from_line(String.t()) :: t()
@spec installable?(t()) :: boolean()
Link to this function

installable_until(entry)

View Source
@spec installable_until(t()) :: Croma.TypeGen.Nilable.Antikythera.Time.t()

Type-aware getter for installable_until.

Link to this function

installable_until(s, field)

View Source
@spec installable_until(t(), Croma.TypeGen.Nilable.Antikythera.Time.t()) :: t()

Type-aware setter for installable_until.

@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.Version.History.Entry by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input
@spec new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

@spec noupgrade(t()) :: Croma.Boolean.t()

Type-aware getter for noupgrade.

@spec noupgrade(t(), Croma.Boolean.t()) :: t()

Type-aware setter for noupgrade.

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraCore.Version.History.Entry with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

@spec update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

@spec upgradable?(t()) :: boolean()
@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.

@spec version(t()) :: Antikythera.VersionStr.t()

Type-aware getter for version.

@spec version(t(), Antikythera.VersionStr.t()) :: t()

Type-aware setter for version.