View Source Dagger.Directory (dagger v0.12.3)

A directory.

Summary

Types

t()

Functions

as_module(directory, optional_args \\ [])

Load the directory as a Dagger module

diff(directory, other)

Gets the difference between this directory and an another directory.

directory(directory, path)

Retrieves a directory at the given path.

docker_build(directory, optional_args \\ [])

Builds a new Docker container from this directory.

entries(directory, optional_args \\ [])

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

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

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

file(directory, path)

Retrieves a file at the given path.

glob(directory, pattern)

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

id(directory)

A unique identifier for this Directory.

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

Creates a named sub-pipeline.

sync(directory)

Force evaluation in the engine.

terminal(directory, optional_args \\ [])

Opens an interactive terminal in new container with this directory mounted inside.

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

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

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

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

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

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

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

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

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

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

with_timestamps(directory, timestamp)

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

without_directory(directory, path)

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

without_file(directory, path)

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

Types

t()

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

Functions

as_module(directory, optional_args \\ [])

@spec as_module(t(),
  source_root_path: String.t() | nil,
  engine_version: String.t() | nil
) ::
  Dagger.Module.t()

Load the directory as a Dagger module

diff(directory, other)

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

Gets the difference between this directory and an another directory.

directory(directory, path)

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

Retrieves a directory at the given path.

docker_build(directory, optional_args \\ [])

@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.

entries(directory, optional_args \\ [])

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

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

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

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

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

file(directory, path)

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

Retrieves a file at the given path.

glob(directory, pattern)

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

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

id(directory)

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

A unique identifier for this Directory.

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

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

Creates a named sub-pipeline.

sync(directory)

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

Force evaluation in the engine.

terminal(directory, optional_args \\ [])

@spec terminal(t(),
  cmd: [String.t()],
  experimental_privileged_nesting: boolean() | nil,
  insecure_root_capabilities: boolean() | nil,
  container: Dagger.ContainerID.t() | nil
) :: t()

Opens an interactive terminal in new container with this directory mounted inside.

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

@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.

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

@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.

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

@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.

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

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

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

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

@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.

with_timestamps(directory, timestamp)

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

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

without_directory(directory, path)

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

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

without_file(directory, path)

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

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