Dagger.Check (dagger v1.0.0-beta.18)

Copy Markdown View Source

One deferred check. Reading pass, error, or sync runs it.

Summary

Types

t()

Functions

assertion(check)

The assertion that is false when this check fails.

error(check)

Run the check and return its failure, if any.

id(check)

A unique identifier for this Check.

pass(check)

Run the check and return whether it passes.

report(check)

An optional report produced by the check.

sync(check)

Run the check and retain its result.

Types

t()

@type t() :: %Dagger.Check{client: term(), query_builder: term()}

Functions

assertion(check)

@spec assertion(t()) :: {:ok, String.t() | nil} | {:error, term()}

The assertion that is false when this check fails.

error(check)

@spec error(t()) :: {:ok, Dagger.Error.t() | nil} | {:error, term()}

Run the check and return its failure, if any.

id(check)

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

A unique identifier for this Check.

pass(check)

@spec pass(t()) :: {:ok, boolean()} | {:error, term()}

Run the check and return whether it passes.

report(check)

@spec report(t()) :: {:ok, Dagger.Directory.t() | nil} | {:error, term()}

An optional report produced by the check.

sync(check)

@spec sync(t()) :: t()

Run the check and retain its result.