Skip to main content

Workspace

Struct Workspace 

Source
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§

Source§

impl Workspace

Source

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

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

Source

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

Returns a Directory from the workspace. Path is relative to workspace root. Use “.” for the root directory.

§Arguments
  • path - Location of the directory to retrieve, relative to the workspace root (e.g., “src”, “.”).
  • opt - optional argument, see inner type for documentation, use _opts to use
Source

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

Returns a Directory from the workspace. Path is relative to workspace root. Use “.” for the root directory.

§Arguments
  • path - Location of the directory to retrieve, relative to the workspace root (e.g., “src”, “.”).
  • opt - optional argument, see inner type for documentation, use _opts to use
Source

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

Returns a File from the workspace. Path is relative to workspace root.

§Arguments
  • path - Location of the file to retrieve, relative to the workspace root (e.g., “go.mod”).
Source

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 path relative to the workspace root if found, or null if not found. The search stops at the workspace root 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
Source

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 path relative to the workspace root if found, or null if not found. The search stops at the workspace root 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
Source

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

A unique identifier for this Workspace.

Source

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

Absolute path to the workspace root directory.

Trait Implementations§

Source§

impl Clone for Workspace

Source§

fn clone(&self) -> Workspace

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl IntoID<WorkspaceId> for Workspace

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more