Struct Workspace 

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

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl Workspace

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

Canonical Dagger address of the workspace directory.

pub fn checks(&self) -> CheckGroup

Return all checks from modules loaded in the workspace.

Arguments

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

pub fn checks_opts<'a>(&self, opts: WorkspaceChecksOpts<'a>) -> CheckGroup

Return all checks from modules loaded in the workspace.

Arguments

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

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

The client ID that owns this workspace’s host filesystem.

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

Path to config.toml relative to the workspace boundary (empty if not initialized).

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

Returns a Directory from the workspace. Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

Arguments

• path - Location of the directory to retrieve. Relative paths (e.g., “src”) resolve from the workspace directory; absolute paths (e.g., “/src”) resolve from the workspace boundary.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn directory_opts<'a>( &self, path: impl Into<String>, opts: WorkspaceDirectoryOpts<'a>, ) -> Directory

Returns a Directory from the workspace. Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

Arguments

• path - Location of the directory to retrieve. Relative paths (e.g., “src”) resolve from the workspace directory; absolute paths (e.g., “/src”) resolve from the workspace boundary.
• opt - optional argument, see inner type for documentation, use _opts to use

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

Returns a File from the workspace. Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

Arguments

• path - Location of the file to retrieve. Relative paths (e.g., “go.mod”) resolve from the workspace directory; absolute paths (e.g., “/go.mod”) resolve from the workspace boundary.

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

Search for a file or directory by walking up from the start path within the workspace. Returns the absolute workspace path if found, or null if not found. Relative start paths resolve from the workspace directory. The search stops at the workspace boundary and will not traverse above it.

Arguments

• name - The name of the file or directory to search for.
• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn find_up_opts<'a>( &self, name: impl Into<String>, opts: WorkspaceFindUpOpts<'a>, ) -> Result<String, DaggerError>

Search for a file or directory by walking up from the start path within the workspace. Returns the absolute workspace path if found, or null if not found. Relative start paths resolve from the workspace directory. The search stops at the workspace boundary and will not traverse above it.

Arguments

• name - The name of the file or directory to search for.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn generators(&self) -> GeneratorGroup

Return all generators from modules loaded in the workspace.

Arguments

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

pub fn generators_opts<'a>( &self, opts: WorkspaceGeneratorsOpts<'a>, ) -> GeneratorGroup

Return all generators from modules loaded in the workspace.

Arguments

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

pub async fn has_config(&self) -> Result<bool, DaggerError>

Whether a config.toml file exists in the workspace.

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

A unique identifier for this Workspace.

pub async fn initialized(&self) -> Result<bool, DaggerError>

Whether .dagger/config.toml exists.

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

Workspace directory path relative to the workspace boundary.

pub fn services(&self) -> UpGroup

Return all services from modules loaded in the workspace.

Arguments

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

pub fn services_opts<'a>(&self, opts: WorkspaceServicesOpts<'a>) -> UpGroup

Return all services from modules loaded in the workspace.

Arguments

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

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoID<WorkspaceId> for Workspace

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