View Source Dagger.Directory (dagger v0.11.4)

A directory.

Summary

Functions

Load the directory as a Dagger module

Gets the difference between this directory and an another directory.

Retrieves a directory at the given path.

Builds a new Docker container from this directory.

Returns a list of files and directories at the given path.

Writes the contents of the directory to a path on the host.

Retrieves a file at the given path.

Returns a list of files and directories that matche the given pattern.

A unique identifier for this Directory.

Creates a named sub-pipeline.

Force evaluation in the engine.

Retrieves this directory plus a directory written at the given path.

Retrieves this directory plus the contents of the given file copied to the given path.

Retrieves this directory plus the contents of the given files copied to the given path.

Retrieves this directory plus a new directory created at the given path.

Retrieves this directory plus a new file written at the given path.

Retrieves this directory with all file/dir timestamps set to the given time.

Retrieves this directory with the directory at the given path removed.

Retrieves this directory with the file at the given path removed.

Types

@type t() :: %Dagger.Directory{client: term(), selection: term()}

Functions

Link to this function

as_module(directory, optional_args \\ [])

View Source
@spec as_module(t(), [{:source_root_path, String.t() | nil}]) :: Dagger.Module.t()

Load the directory as a Dagger module

@spec diff(t(), t()) :: t()

Gets the difference between this directory and an another directory.

Link to this function

directory(directory, path)

View Source
@spec directory(t(), String.t()) :: t()

Retrieves a directory at the given path.

Link to this function

docker_build(directory, optional_args \\ [])

View Source
@spec docker_build(t(),
  platform: Dagger.Platform.t() | nil,
  dockerfile: String.t() | nil,
  target: String.t() | nil,
  build_args: [Dagger.BuildArg.t()],
  secrets: [Dagger.SecretID.t()]
) :: Dagger.Container.t()

Builds a new Docker container from this directory.

Link to this function

entries(directory, optional_args \\ [])

View Source
@spec entries(t(), [{:path, String.t() | nil}]) ::
  {:ok, [String.t()]} | {:error, term()}

Returns a list of files and directories at the given path.

Link to this function

export(directory, path, optional_args \\ [])

View Source
@spec export(t(), String.t(), [{:wipe, boolean() | nil}]) ::
  {:ok, boolean()} | {:error, term()}

Writes the contents of the directory to a path on the host.

@spec file(t(), String.t()) :: Dagger.File.t()

Retrieves a file at the given path.

Link to this function

glob(directory, pattern)

View Source
@spec glob(t(), String.t()) :: {:ok, [String.t()]} | {:error, term()}

Returns a list of files and directories that matche the given pattern.

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

A unique identifier for this Directory.

Link to this function

pipeline(directory, name, optional_args \\ [])

View Source
@spec pipeline(t(), String.t(),
  description: String.t() | nil,
  labels: [Dagger.PipelineLabel.t()]
) ::
  t()

Creates a named sub-pipeline.

@spec sync(t()) :: {:ok, Dagger.DirectoryID.t()} | {:error, term()}

Force evaluation in the engine.

Link to this function

with_directory(directory, path, directory, optional_args \\ [])

View Source
@spec with_directory(t(), String.t(), t(),
  exclude: [String.t()],
  include: [String.t()]
) :: t()

Retrieves this directory plus a directory written at the given path.

Link to this function

with_file(directory, path, source, optional_args \\ [])

View Source
@spec with_file(t(), String.t(), Dagger.File.t(), [{:permissions, integer() | nil}]) ::
  t()

Retrieves this directory plus the contents of the given file copied to the given path.

Link to this function

with_files(directory, path, sources, optional_args \\ [])

View Source
@spec with_files(t(), String.t(), [Dagger.FileID.t()], [
  {:permissions, integer() | nil}
]) :: t()

Retrieves this directory plus the contents of the given files copied to the given path.

Link to this function

with_new_directory(directory, path, optional_args \\ [])

View Source
@spec with_new_directory(t(), String.t(), [{:permissions, integer() | nil}]) :: t()

Retrieves this directory plus a new directory created at the given path.

Link to this function

with_new_file(directory, path, contents, optional_args \\ [])

View Source
@spec with_new_file(t(), String.t(), String.t(), [{:permissions, integer() | nil}]) ::
  t()

Retrieves this directory plus a new file written at the given path.

Link to this function

with_timestamps(directory, timestamp)

View Source
@spec with_timestamps(t(), integer()) :: t()

Retrieves this directory with all file/dir timestamps set to the given time.

Link to this function

without_directory(directory, path)

View Source
@spec without_directory(t(), String.t()) :: t()

Retrieves this directory with the directory at the given path removed.

Link to this function

without_file(directory, path)

View Source
@spec without_file(t(), String.t()) :: t()

Retrieves this directory with the file at the given path removed.