Struct File

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

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl File

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

Retrieves the contents of the file.

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

Return the file’s digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.

Arguments

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

pub async fn digest_opts( &self, opts: FileDigestOpts, ) -> Result<String, DaggerError>

Return the file’s digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.

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 file to a file path on the host.

Arguments

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

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

Writes the file to a file path on the host.

Arguments

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

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

A unique identifier for this File.

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

Retrieves the name of the file.

pub async fn size(&self) -> Result<isize, DaggerError>

Retrieves the size of the file, in bytes.

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

Force evaluation in the engine.

pub fn with_name(&self, name: impl Into<String>) -> File

Retrieves this file with its name set to the given name.

Arguments

• name - Name to set file to.

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

Retrieves this file with its created/modified timestamps set to the given time.

Arguments

• timestamp - Timestamp to set dir/files in.

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

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoID<FileId> for File

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