Struct dagger_sdk::TypeDef

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

Fields

proc: Option<Arc<Child>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl TypeDef

pub fn as_list(&self) -> ListTypeDef

If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.

pub fn as_object(&self) -> ObjectTypeDef

If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

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

pub async fn kind(&self) -> Result<TypeDefKind, DaggerError>

The kind of type this is (e.g. primitive, list, object)

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

Whether this type can be set to null. Defaults to false.

pub fn with_field(&self, name: impl Into<String>, type_def: TypeDef) -> TypeDef

Adds a static field for an Object TypeDef, failing if the type is not an object.

Arguments

• name - The name of the field in the object
• type_def - The type of the field
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_field_opts<'a>( &self, name: impl Into<String>, type_def: TypeDef, opts: TypeDefWithFieldOpts<'a> ) -> TypeDef

Adds a static field for an Object TypeDef, failing if the type is not an object.

Arguments

• name - The name of the field in the object
• type_def - The type of the field
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_function(&self, function: Function) -> TypeDef

Adds a function for an Object TypeDef, failing if the type is not an object.

pub fn with_kind(&self, kind: TypeDefKind) -> TypeDef

Sets the kind of the type.

pub fn with_list_of(&self, element_type: TypeDef) -> TypeDef

Returns a TypeDef of kind List with the provided type for its elements.

pub fn with_object(&self, name: impl Into<String>) -> TypeDef

Returns a TypeDef of kind Object with the provided name. Note that an object’s fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.

Arguments

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

pub fn with_object_opts<'a>( &self, name: impl Into<String>, opts: TypeDefWithObjectOpts<'a> ) -> TypeDef

Returns a TypeDef of kind Object with the provided name. Note that an object’s fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.

Arguments

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

pub fn with_optional(&self, optional: bool) -> TypeDef

Sets whether this type can be set to null.

Trait Implementations

impl Clone for TypeDef

fn clone(&self) -> TypeDef

Returns a copy of the value.

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

Performs copy-assignment from source.