Struct dagger_sdk::Directory

pub struct Directory {
    pub proc: Option<Arc<DaggerSessionProc>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Directory

pub fn as_module(&self) -> Module

Load the directory as a Dagger module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn as_module_opts<'a>(&self, opts: DirectoryAsModuleOpts<'a>) -> Module

Load the directory as a Dagger module

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn diff(&self, other: impl IntoID<DirectoryId>) -> Directory

Gets the difference between this directory and an another directory.

Arguments

• other - Identifier of the directory to compare.

pub fn directory(&self, path: impl Into<String>) -> Directory

Retrieves a directory at the given path.

Arguments

• path - Location of the directory to retrieve (e.g., “/src”).

pub fn docker_build(&self) -> Container

Builds a new Docker container from this directory.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn docker_build_opts<'a>( &self, opts: DirectoryDockerBuildOpts<'a>, ) -> Container

Builds a new Docker container from this directory.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn entries(&self) -> Result<Vec<String>, DaggerError>

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

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn entries_opts<'a>( &self, opts: DirectoryEntriesOpts<'a>, ) -> Result<Vec<String>, DaggerError>

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

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn export( &self, path: impl Into<String>, ) -> Result<String, DaggerError>

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

Arguments

• path - Location of the copied directory (e.g., “logs/”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn export_opts( &self, path: impl Into<String>, opts: DirectoryExportOpts, ) -> Result<String, DaggerError>

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

Arguments

• path - Location of the copied directory (e.g., “logs/”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn file(&self, path: impl Into<String>) -> File

Retrieves a file at the given path.

Arguments

• path - Location of the file to retrieve (e.g., “README.md”).

pub async fn glob( &self, pattern: impl Into<String>, ) -> Result<Vec<String>, DaggerError>

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

Arguments

• pattern - Pattern to match (e.g., “*.md”).

pub async fn id(&self) -> Result<DirectoryId, DaggerError>

A unique identifier for this Directory.

pub fn pipeline(&self, name: impl Into<String>) -> Directory

Creates a named sub-pipeline.

Arguments

• name - Name of the sub-pipeline.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn pipeline_opts<'a>( &self, name: impl Into<String>, opts: DirectoryPipelineOpts<'a>, ) -> Directory

Creates a named sub-pipeline.

Arguments

• name - Name of the sub-pipeline.
• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn sync(&self) -> Result<DirectoryId, DaggerError>

Force evaluation in the engine.

pub fn terminal(&self) -> Directory

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

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn terminal_opts<'a>(&self, opts: DirectoryTerminalOpts<'a>) -> Directory

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

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_directory( &self, path: impl Into<String>, directory: impl IntoID<DirectoryId>, ) -> Directory

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

Arguments

• path - Location of the written directory (e.g., “/src/”).
• directory - Identifier of the directory to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_directory_opts<'a>( &self, path: impl Into<String>, directory: impl IntoID<DirectoryId>, opts: DirectoryWithDirectoryOpts<'a>, ) -> Directory

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

Arguments

• path - Location of the written directory (e.g., “/src/”).
• directory - Identifier of the directory to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_file( &self, path: impl Into<String>, source: impl IntoID<FileId>, ) -> Directory

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

Arguments

• path - Location of the copied file (e.g., “/file.txt”).
• source - Identifier of the file to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_file_opts( &self, path: impl Into<String>, source: impl IntoID<FileId>, opts: DirectoryWithFileOpts, ) -> Directory

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

Arguments

• path - Location of the copied file (e.g., “/file.txt”).
• source - Identifier of the file to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_files( &self, path: impl Into<String>, sources: Vec<FileId>, ) -> Directory

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

Arguments

• path - Location where copied files should be placed (e.g., “/src”).
• sources - Identifiers of the files to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_files_opts( &self, path: impl Into<String>, sources: Vec<FileId>, opts: DirectoryWithFilesOpts, ) -> Directory

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

Arguments

• path - Location where copied files should be placed (e.g., “/src”).
• sources - Identifiers of the files to copy.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_new_directory(&self, path: impl Into<String>) -> Directory

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

Arguments

• path - Location of the directory created (e.g., “/logs”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_new_directory_opts( &self, path: impl Into<String>, opts: DirectoryWithNewDirectoryOpts, ) -> Directory

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

Arguments

• path - Location of the directory created (e.g., “/logs”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_new_file( &self, path: impl Into<String>, contents: impl Into<String>, ) -> Directory

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

Arguments

• path - Location of the written file (e.g., “/file.txt”).
• contents - Content of the written file (e.g., “Hello world!”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_new_file_opts( &self, path: impl Into<String>, contents: impl Into<String>, opts: DirectoryWithNewFileOpts, ) -> Directory

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

Arguments

• path - Location of the written file (e.g., “/file.txt”).
• contents - Content of the written file (e.g., “Hello world!”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_timestamps(&self, timestamp: isize) -> Directory

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

Arguments

• timestamp - Timestamp to set dir/files in.

Formatted in seconds following Unix epoch (e.g., 1672531199).

pub fn without_directory(&self, path: impl Into<String>) -> Directory

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

Arguments

• path - Location of the directory to remove (e.g., “.github/”).

pub fn without_file(&self, path: impl Into<String>) -> Directory

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

Arguments

• path - Location of the file to remove (e.g., “/file.txt”).

Trait Implementations

impl Clone for Directory

fn clone(&self) -> Directory

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl IntoID<DirectoryId> for Directory

fn into_id( self, ) -> Pin<Box<dyn Future<Output = Result<DirectoryId, DaggerError>> + Send>>