xattr

Documentation

Overview

Package xattr contains additional interfaces for attr types. This package is separate from the core attr package to prevent import cycles.

Index

• type TypeWithValidate
• type ValidateAttributeRequest
• type ValidateAttributeResponse
• type ValidateableAttribute

Types

type TypeWithValidate

type TypeWithValidate interface {
	attr.Type

	// Validate returns any warnings or errors about the value that is
	// being used to populate the Type. It is generally used to check the
	// data format and ensure that it complies with the requirements of the
	// Type.
	Validate(context.Context, tftypes.Value, path.Path) diag.Diagnostics
}

TypeWithValidate extends the attr.Type interface to include a Validate method, used to bundle consistent validation logic with the Type.

Deprecated: Use the ValidateableAttribute interface instead for schema attribute validation. Use the function.ValidateableParameter interface for provider-defined function parameter validation.

type ValidateAttributeRequest

type ValidateAttributeRequest struct {
	// Path is the path to the attribute being validated.
	Path path.Path
}

ValidateAttributeRequest represents a request for the Value to call its validation logic. An instance of this request struct is supplied as an argument to the ValidateAttribute method.

type ValidateAttributeResponse

type ValidateAttributeResponse struct {
	// Diagnostics is a collection of warnings or errors generated during
	// validation of the Value.
	Diagnostics diag.Diagnostics
}

ValidateAttributeResponse represents a response to a ValidateAttributeRequest. An instance of this response struct is supplied as an argument to the ValidateAttribute method.

type ValidateableAttribute

type ValidateableAttribute interface {
	// ValidateAttribute returns any warnings or errors generated during validation
	// of the attribute. It is generally used to check the data format and ensure
	// that it complies with the requirements of the Value.
	ValidateAttribute(context.Context, ValidateAttributeRequest, *ValidateAttributeResponse)
}

ValidateableAttribute defines an interface for validating an attribute value. The ValidateAttribute method is called implicitly by the framework when value types from Terraform are converted into framework types.