Struct dagger_sdk::Query

pub struct Query {
    pub proc: Option<Arc<Child>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<Child>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Query

pub fn cache_volume(&self, key: impl Into<String>) -> CacheVolume

Constructs a cache volume for a given cache key.

Arguments

• key - A string identifier to target this cache volume (e.g., “modules-cache”).

pub async fn check_version_compatibility( &self, version: impl Into<String> ) -> Result<bool, DaggerError>

Checks if the current Dagger Engine is compatible with an SDK’s required version.

Arguments

• version - The SDK’s required version.

pub fn container(&self) -> Container

Loads a container from ID. Null ID returns an empty container (scratch). Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder’s host.

Arguments

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

pub fn container_opts(&self, opts: QueryContainerOpts) -> Container

Loads a container from ID. Null ID returns an empty container (scratch). Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder’s host.

Arguments

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

pub async fn default_platform(&self) -> Result<Platform, DaggerError>

The default platform of the builder.

pub fn directory(&self) -> Directory

Load a directory by ID. No argument produces an empty directory.

Arguments

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

pub fn directory_opts(&self, opts: QueryDirectoryOpts) -> Directory

Load a directory by ID. No argument produces an empty directory.

Arguments

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

pub fn file(&self, id: FileId) -> File

Loads a file by ID.

pub fn git(&self, url: impl Into<String>) -> GitRepository

Queries a git repository.

Arguments

• url - Url of the git repository. Can be formatted as https://{host}/{owner}/{repo}, git@{host}/{owner}/{repo} Suffix “.git” is optional.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn git_opts( &self, url: impl Into<String>, opts: QueryGitOpts ) -> GitRepository

Queries a git repository.

Arguments

• url - Url of the git repository. Can be formatted as https://{host}/{owner}/{repo}, git@{host}/{owner}/{repo} Suffix “.git” is optional.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn host(&self) -> Host

Queries the host environment.

pub fn http(&self, url: impl Into<String>) -> File

Returns a file containing an http remote url content.

Arguments

• url - HTTP url to get the content from (e.g., “https://docs.dagger.io”).
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn http_opts(&self, url: impl Into<String>, opts: QueryHttpOpts) -> File

Returns a file containing an http remote url content.

Arguments

• url - HTTP url to get the content from (e.g., “https://docs.dagger.io”).
• opt - optional argument, see inner type for documentation, use _opts to use

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

Creates a named sub-pipeline.

Arguments

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

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

Creates a named sub-pipeline.

Arguments

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

pub fn project(&self) -> Project

Load a project from ID.

Arguments

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

pub fn project_opts(&self, opts: QueryProjectOpts) -> Project

Load a project from ID.

Arguments

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

pub fn project_command(&self) -> ProjectCommand

Load a project command from ID.

Arguments

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

pub fn project_command_opts( &self, opts: QueryProjectCommandOpts ) -> ProjectCommand

Load a project command from ID.

Arguments

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

pub fn secret(&self, id: SecretId) -> Secret

Loads a secret from its ID.

pub fn set_secret( &self, name: impl Into<String>, plaintext: impl Into<String> ) -> Secret

Sets a secret given a user defined name to its plaintext and returns the secret. The plaintext value is limited to a size of 128000 bytes.

Arguments

• name - The user defined name for this secret
• plaintext - The plaintext of the secret

pub fn socket(&self) -> Socket

Loads a socket by its ID.

Arguments

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

pub fn socket_opts(&self, opts: QuerySocketOpts) -> Socket

Loads a socket by its ID.

Arguments

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

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.