dagger-rs/crates/dagger-sdk/src/gen.rs

use dagger_core::{Boolean, Input, Int, Scalar};

// code generated by dagger. DO NOT EDIT.

/// A global cache volume identifier.
pub struct CacheID(Scalar);

/// A unique container identifier. Null designates an empty container (scratch).
pub struct ContainerID(Scalar);

/// A content-addressed directory identifier.
pub struct DirectoryID(Scalar);

/// A file identifier.
pub struct FileID(Scalar);

/// The platform config OS and architecture in a Container.
/// The format is [os]/[platform]/[version] (e.g. darwin/arm64/v7, windows/amd64, linux/arm64).
pub struct Platform(Scalar);

/// A unique identifier for a secret.
pub struct SecretID(Scalar);

/// A content-addressed socket identifier.
pub struct SocketID(Scalar);

///
pub struct BuildArg {
    pub name: String,

    pub value: String,
}

impl Input for BuildArg {}

/// A directory whose contents persist across runs.
pub struct CacheVolume {}

impl CacheVolume {
    ///
    pub fn id(&self) -> CacheID {
        todo!()
    }
}

impl Input for CacheVolume {}

/// An OCI-compatible container, also known as a docker container.
pub struct Container {}

impl Container {
    /// Initializes this container from a Dockerfile build, using the context, a dockerfile file path and some additional buildArgs.
    /// # Arguments
    ///
    /// * `context` - Directory context used by the Dockerfile.
    /// * `dockerfile` - Path to the Dockerfile to use.
    ///   Defaults to './Dockerfile'.
    /// * `buildArgs` - Additional build arguments.
    /// * `target` - Target build stage to build.
    pub fn build(
        &self,
        context: DirectoryID,
        dockerfile: Option<String>,
        build_args: Option<Vec<BuildArg>>,
        target: Option<String>,
    ) -> Container {
        todo!()
    }

    /// Retrieves default arguments for future commands.
    pub fn default_args(&self) -> Option<Vec<String>> {
        todo!()
    }

    /// Retrieves a directory at the given path. Mounts are included.
    pub fn directory(&self, path: String) -> Directory {
        todo!()
    }

    /// Retrieves entrypoint to be prepended to the arguments of all commands.
    pub fn entrypoint(&self) -> Option<Vec<String>> {
        todo!()
    }

    /// Retrieves the value of the specified environment variable.
    pub fn env_variable(&self, name: String) -> Option<String> {
        todo!()
    }

    /// Retrieves the list of environment variables passed to commands.
    pub fn env_variables(&self) -> Vec<EnvVariable> {
        todo!()
    }

    /// Retrieves this container after executing the specified command inside it.
    /// # Arguments
    ///
    /// * `args` - Command to run instead of the container's default command.
    /// * `stdin` - Content to write to the command's standard input before closing.
    /// * `redirectStdout` - Redirect the command's standard output to a file in the container.
    /// * `redirectStderr` - Redirect the command's standard error to a file in the container.
    /// * `experimentalPrivilegedNesting` - Provide dagger access to the executed command.
    ///   Do not use this option unless you trust the command being executed.
    ///   The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
    pub fn exec(
        &self,
        args: Option<Vec<String>>,
        stdin: Option<String>,
        redirect_stdout: Option<String>,
        redirect_stderr: Option<String>,
        experimental_privileged_nesting: Option<Boolean>,
    ) -> Container {
        todo!()
    }

    /// Exit code of the last executed command. Zero means success.
    /// Null if no command has been executed.
    pub fn exit_code(&self) -> Option<Int> {
        todo!()
    }

    /// Writes the container as an OCI tarball to the destination file path on the host for the specified platformVariants.
    /// Return true on success.
    /// # Arguments
    ///
    /// * `path` - Host's destination path.
    ///   Path can be relative to the engine's workdir or absolute.
    /// * `platformVariants` - Identifiers for other platform specific containers.
    ///   Used for multi-platform image.
    pub fn export(&self, path: String, platform_variants: Option<Vec<ContainerID>>) -> Boolean {
        todo!()
    }

    /// Retrieves a file at the given path. Mounts are included.
    pub fn file(&self, path: String) -> File {
        todo!()
    }

    /// Initializes this container from the base image published at the given address.
    /// # Arguments
    ///
    /// * `address` - Image's address from its registry.
    ///   Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
    pub fn from(&self, address: String) -> Container {
        todo!()
    }

    /// Retrieves this container's root filesystem. Mounts are not included.
    pub fn fs(&self) -> Directory {
        todo!()
    }

    /// A unique identifier for this container.
    pub fn id(&self) -> ContainerID {
        todo!()
    }

    /// Retrieves the value of the specified label.
    pub fn label(&self, name: String) -> Option<String> {
        todo!()
    }

    /// Retrieves the list of labels passed to container.
    pub fn labels(&self) -> Vec<Label> {
        todo!()
    }

    /// Retrieves the list of paths where a directory is mounted.
    pub fn mounts(&self) -> Vec<String> {
        todo!()
    }

    /// Creates a named sub-pipeline
    pub fn pipeline(&self, name: String, description: Option<String>) -> Container {
        todo!()
    }

    /// The platform this container executes and publishes as.
    pub fn platform(&self) -> Platform {
        todo!()
    }

    /// Publishes this container as a new image to the specified address, for the platformVariants, returning a fully qualified ref.
    /// # Arguments
    ///
    /// * `address` - Registry's address to publish the image to.
    ///   Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
    /// * `platformVariants` - Identifiers for other platform specific containers.
    ///   Used for multi-platform image.
    pub fn publish(&self, address: String, platform_variants: Option<Vec<ContainerID>>) -> String {
        todo!()
    }

    /// Retrieves this container's root filesystem. Mounts are not included.
    pub fn rootfs(&self) -> Directory {
        todo!()
    }

    /// The error stream of the last executed command.
    /// Null if no command has been executed.
    pub fn stderr(&self) -> Option<String> {
        todo!()
    }

    /// The output stream of the last executed command.
    /// Null if no command has been executed.
    pub fn stdout(&self) -> Option<String> {
        todo!()
    }

    /// Retrieves the user to be set for all commands.
    pub fn user(&self) -> Option<String> {
        todo!()
    }

    /// Configures default arguments for future commands.
    pub fn with_default_args(&self, args: Option<Vec<String>>) -> Container {
        todo!()
    }

    /// Retrieves this container plus a directory written at the given path.
    pub fn with_directory(
        &self,
        path: String,
        directory: DirectoryID,
        exclude: Option<Vec<String>>,
        include: Option<Vec<String>>,
    ) -> Container {
        todo!()
    }

    /// Retrieves this container but with a different command entrypoint.
    pub fn with_entrypoint(&self, args: Vec<String>) -> Container {
        todo!()
    }

    /// Retrieves this container plus the given environment variable.
    pub fn with_env_variable(&self, name: String, value: String) -> Container {
        todo!()
    }

    /// Retrieves this container after executing the specified command inside it.
    /// # Arguments
    ///
    /// * `args` - Command to run instead of the container's default command.
    /// * `stdin` - Content to write to the command's standard input before closing.
    /// * `redirectStdout` - Redirect the command's standard output to a file in the container.
    /// * `redirectStderr` - Redirect the command's standard error to a file in the container.
    /// * `experimentalPrivilegedNesting` - Provide dagger access to the executed command.
    ///   Do not use this option unless you trust the command being executed.
    ///   The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
    pub fn with_exec(
        &self,
        args: Vec<String>,
        stdin: Option<String>,
        redirect_stdout: Option<String>,
        redirect_stderr: Option<String>,
        experimental_privileged_nesting: Option<Boolean>,
    ) -> Container {
        todo!()
    }

    /// Initializes this container from this DirectoryID.
    pub fn with_fs(&self, id: DirectoryID) -> Container {
        todo!()
    }

    /// Retrieves this container plus the contents of the given file copied to the given path.
    pub fn with_file(&self, path: String, source: FileID, permissions: Option<Int>) -> Container {
        todo!()
    }

    /// Retrieves this container plus the given label.
    pub fn with_label(&self, name: String, value: String) -> Container {
        todo!()
    }

    /// Retrieves this container plus a cache volume mounted at the given path.
    pub fn with_mounted_cache(
        &self,
        path: String,
        cache: CacheID,
        source: Option<DirectoryID>,
    ) -> Container {
        todo!()
    }

    /// Retrieves this container plus a directory mounted at the given path.
    pub fn with_mounted_directory(&self, path: String, source: DirectoryID) -> Container {
        todo!()
    }

    /// Retrieves this container plus a file mounted at the given path.
    pub fn with_mounted_file(&self, path: String, source: FileID) -> Container {
        todo!()
    }

    /// Retrieves this container plus a secret mounted into a file at the given path.
    pub fn with_mounted_secret(&self, path: String, source: SecretID) -> Container {
        todo!()
    }

    /// Retrieves this container plus a temporary directory mounted at the given path.
    pub fn with_mounted_temp(&self, path: String) -> Container {
        todo!()
    }

    /// Retrieves this container plus a new file written at the given path.
    pub fn with_new_file(
        &self,
        path: String,
        contents: Option<String>,
        permissions: Option<Int>,
    ) -> Container {
        todo!()
    }

    /// Initializes this container from this DirectoryID.
    pub fn with_rootfs(&self, id: DirectoryID) -> Container {
        todo!()
    }

    /// Retrieves this container plus an env variable containing the given secret.
    pub fn with_secret_variable(&self, name: String, secret: SecretID) -> Container {
        todo!()
    }

    /// Retrieves this container plus a socket forwarded to the given Unix socket path.
    pub fn with_unix_socket(&self, path: String, source: SocketID) -> Container {
        todo!()
    }

    /// Retrieves this containers with a different command user.
    pub fn with_user(&self, name: String) -> Container {
        todo!()
    }

    /// Retrieves this container with a different working directory.
    pub fn with_workdir(&self, path: String) -> Container {
        todo!()
    }

    /// Retrieves this container minus the given environment variable.
    pub fn without_env_variable(&self, name: String) -> Container {
        todo!()
    }

    /// Retrieves this container minus the given environment label.
    pub fn without_label(&self, name: String) -> Container {
        todo!()
    }

    /// Retrieves this container after unmounting everything at the given path.
    pub fn without_mount(&self, path: String) -> Container {
        todo!()
    }

    /// Retrieves this container with a previously added Unix socket removed.
    pub fn without_unix_socket(&self, path: String) -> Container {
        todo!()
    }

    /// Retrieves the working directory for all commands.
    pub fn workdir(&self) -> Option<String> {
        todo!()
    }
}

impl Input for Container {}

/// A directory.
pub struct Directory {}

impl Directory {
    /// Gets the difference between this directory and an another directory.
    pub fn diff(&self, other: DirectoryID) -> Directory {
        todo!()
    }

    /// Retrieves a directory at the given path.
    pub fn directory(&self, path: String) -> Directory {
        todo!()
    }

    /// Builds a new Docker container from this directory.
    /// # Arguments
    ///
    /// * `dockerfile` - Path to the Dockerfile to use.
    ///   Defaults to './Dockerfile'.
    /// * `platform` - The platform to build.
    /// * `buildArgs` - Additional build arguments.
    /// * `target` - Target build stage to build.
    pub fn docker_build(
        &self,
        dockerfile: Option<String>,
        platform: Option<Platform>,
        build_args: Option<Vec<BuildArg>>,
        target: Option<String>,
    ) -> Container {
        todo!()
    }

    /// Returns a list of files and directories at the given path.
    pub fn entries(&self, path: Option<String>) -> Vec<String> {
        todo!()
    }

    /// Writes the contents of the directory to a path on the host.
    pub fn export(&self, path: String) -> Boolean {
        todo!()
    }

    /// Retrieves a file at the given path.
    pub fn file(&self, path: String) -> File {
        todo!()
    }

    /// The content-addressed identifier of the directory.
    pub fn id(&self) -> DirectoryID {
        todo!()
    }

    /// load a project's metadata
    pub fn load_project(&self, config_path: String) -> Project {
        todo!()
    }

    /// Creates a named sub-pipeline.
    pub fn pipeline(&self, name: String, description: Option<String>) -> Directory {
        todo!()
    }

    /// Retrieves this directory plus a directory written at the given path.
    /// # Arguments
    ///
    /// * `exclude` - Exclude artifacts that match the given pattern.
    ///   (e.g. ["node_modules/", ".git*"]).
    /// * `include` - Include only artifacts that match the given pattern.
    ///   (e.g. ["app/", "package.*"]).
    pub fn with_directory(
        &self,
        path: String,
        directory: DirectoryID,
        exclude: Option<Vec<String>>,
        include: Option<Vec<String>>,
    ) -> Directory {
        todo!()
    }

    /// Retrieves this directory plus the contents of the given file copied to the given path.
    pub fn with_file(&self, path: String, source: FileID, permissions: Option<Int>) -> Directory {
        todo!()
    }

    /// Retrieves this directory plus a new directory created at the given path.
    pub fn with_new_directory(&self, path: String, permissions: Option<Int>) -> Directory {
        todo!()
    }

    /// Retrieves this directory plus a new file written at the given path.
    pub fn with_new_file(
        &self,
        path: String,
        contents: String,
        permissions: Option<Int>,
    ) -> Directory {
        todo!()
    }

    /// Retrieves this directory with all file/dir timestamps set to the given time, in seconds from the Unix epoch.
    pub fn with_timestamps(&self, timestamp: Int) -> Directory {
        todo!()
    }

    /// Retrieves this directory with the directory at the given path removed.
    pub fn without_directory(&self, path: String) -> Directory {
        todo!()
    }

    /// Retrieves this directory with the file at the given path removed.
    pub fn without_file(&self, path: String) -> Directory {
        todo!()
    }
}

impl Input for Directory {}

/// A simple key value object that represents an environment variable.
pub struct EnvVariable {}

impl EnvVariable {
    /// The environment variable name.
    pub fn name(&self) -> String {
        todo!()
    }

    /// The environment variable value.
    pub fn value(&self) -> String {
        todo!()
    }
}

impl Input for EnvVariable {}

/// A file.
pub struct File {}

impl File {
    /// Retrieves the contents of the file.
    pub fn contents(&self) -> String {
        todo!()
    }

    /// Writes the file to a file path on the host.
    pub fn export(&self, path: String) -> Boolean {
        todo!()
    }

    /// Retrieves the content-addressed identifier of the file.
    pub fn id(&self) -> FileID {
        todo!()
    }

    /// Retrieves a secret referencing the contents of this file.
    pub fn secret(&self) -> Secret {
        todo!()
    }

    /// Gets the size of the file, in bytes.
    pub fn size(&self) -> Int {
        todo!()
    }

    /// Retrieves this file with its created/modified timestamps set to the given time, in seconds from the Unix epoch.
    pub fn with_timestamps(&self, timestamp: Int) -> File {
        todo!()
    }
}

impl Input for File {}

/// A git ref (tag, branch or commit).
pub struct GitRef {}

impl GitRef {
    /// The digest of the current value of this ref.
    pub fn digest(&self) -> String {
        todo!()
    }

    /// The filesystem tree at this ref.
    pub fn tree(
        &self,
        ssh_known_hosts: Option<String>,
        ssh_auth_socket: Option<SocketID>,
    ) -> Directory {
        todo!()
    }
}

impl Input for GitRef {}

/// A git repository.
pub struct GitRepository {}

impl GitRepository {
    /// Returns details on one branch.
    pub fn branch(&self, name: String) -> GitRef {
        todo!()
    }

    /// Lists of branches on the repository.
    pub fn branches(&self) -> Vec<String> {
        todo!()
    }

    /// Returns details on one commit.
    pub fn commit(&self, id: String) -> GitRef {
        todo!()
    }

    /// Returns details on one tag.
    pub fn tag(&self, name: String) -> GitRef {
        todo!()
    }

    /// Lists of tags on the repository.
    pub fn tags(&self) -> Vec<String> {
        todo!()
    }
}

impl Input for GitRepository {}

/// Information about the host execution environment.
pub struct Host {}

impl Host {
    /// Accesses a directory on the host.
    pub fn directory(
        &self,
        path: String,
        exclude: Option<Vec<String>>,
        include: Option<Vec<String>>,
    ) -> Directory {
        todo!()
    }

    /// Accesses an environment variable on the host.
    pub fn env_variable(&self, name: String) -> Option<HostVariable> {
        todo!()
    }

    /// Accesses a Unix socket on the host.
    pub fn unix_socket(&self, path: String) -> Socket {
        todo!()
    }

    /// Retrieves the current working directory on the host.
    pub fn workdir(&self, exclude: Option<Vec<String>>, include: Option<Vec<String>>) -> Directory {
        todo!()
    }
}

impl Input for Host {}

/// An environment variable on the host environment.
pub struct HostVariable {}

impl HostVariable {
    /// A secret referencing the value of this variable.
    pub fn secret(&self) -> Secret {
        todo!()
    }

    /// The value of this variable.
    pub fn value(&self) -> String {
        todo!()
    }
}

impl Input for HostVariable {}

/// A simple key value object that represents a label.
pub struct Label {}

impl Label {
    /// The label name.
    pub fn name(&self) -> String {
        todo!()
    }

    /// The label value.
    pub fn value(&self) -> String {
        todo!()
    }
}

impl Input for Label {}

/// A set of scripts and/or extensions
pub struct Project {}

impl Project {
    /// extensions in this project
    pub fn extensions(&self) -> Option<Vec<Project>> {
        todo!()
    }

    /// Code files generated by the SDKs in the project
    pub fn generated_code(&self) -> Directory {
        todo!()
    }

    /// install the project's schema
    pub fn install(&self) -> Boolean {
        todo!()
    }

    /// name of the project
    pub fn name(&self) -> String {
        todo!()
    }

    /// schema provided by the project
    pub fn schema(&self) -> Option<String> {
        todo!()
    }

    /// sdk used to generate code for and/or execute this project
    pub fn sdk(&self) -> Option<String> {
        todo!()
    }
}

impl Input for Project {}

///
pub struct Query {}

impl Query {
    /// Constructs a cache volume for a given cache key.
    /// # Arguments
    ///
    /// * `key` - A string identifier to target this cache volume (e.g. "myapp-cache").
    pub fn cache_volume(&self, key: String) -> CacheVolume {
        todo!()
    }

    /// 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.
    pub fn container(&self, id: Option<ContainerID>, platform: Option<Platform>) -> Container {
        todo!()
    }

    /// The default platform of the builder.
    pub fn default_platform(&self) -> Platform {
        todo!()
    }

    /// Load a directory by ID. No argument produces an empty directory.
    pub fn directory(&self, id: Option<DirectoryID>) -> Directory {
        todo!()
    }

    /// Loads a file by ID.
    pub fn file(&self, id: FileID) -> Option<File> {
        todo!()
    }

    /// Queries a git repository.
    pub fn git(&self, url: String, keep_git_dir: Option<Boolean>) -> GitRepository {
        todo!()
    }

    /// Queries the host environment.
    pub fn host(&self) -> Host {
        todo!()
    }

    /// Returns a file containing an http remote url content.
    pub fn http(&self, url: String) -> File {
        todo!()
    }

    /// Creates a named sub-pipeline
    pub fn pipeline(&self, name: String, description: Option<String>) -> Query {
        todo!()
    }

    /// Look up a project by name
    pub fn project(&self, name: String) -> Project {
        todo!()
    }

    /// Loads a secret from its ID.
    pub fn secret(&self, id: SecretID) -> Secret {
        todo!()
    }

    /// Loads a socket by its ID.
    pub fn socket(&self, id: Option<SocketID>) -> Socket {
        todo!()
    }
}

impl Input for Query {}

/// A reference to a secret value, which can be handled more safely than the value itself.
pub struct Secret {}

impl Secret {
    /// The identifier for this secret.
    pub fn id(&self) -> SecretID {
        todo!()
    }

    /// The value of this secret.
    pub fn plaintext(&self) -> String {
        todo!()
    }
}

impl Input for Secret {}

///
pub struct Socket {}

impl Socket {
    /// The content-addressed identifier of the socket.
    pub fn id(&self) -> SocketID {
        todo!()
    }
}

impl Input for Socket {}