the rest of the refinements

Author: austinvalle

tftypes/refinement/collection_length_lower_bound.go

@@ -0,0 +1,33 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package refinement
+
+// TODO: doc
+type CollectionLengthLowerBound struct {
+	value int64
+}
+
+func (n CollectionLengthLowerBound) Equal(Refinement) bool {
+	// TODO: implement
+	return false
+}
+
+func (n CollectionLengthLowerBound) String() string {
+	// TODO: implement
+	return "todo - CollectionLengthLowerBound"
+}
+
+// TODO: doc
+func (n CollectionLengthLowerBound) LowerBound() int64 {
+	return n.value
+}
+
+func (n CollectionLengthLowerBound) unimplementable() {}
+
+// TODO: doc
+func NewCollectionLengthLowerBound(value int64) Refinement {
+	return CollectionLengthLowerBound{
+		value: value,
+	}
+}

tftypes/refinement/collection_length_upper_bound.go

@@ -0,0 +1,33 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package refinement
+
+// TODO: doc
+type CollectionLengthUpperBound struct {
+	value int64
+}
+
+func (n CollectionLengthUpperBound) Equal(Refinement) bool {
+	// TODO: implement
+	return false
+}
+
+func (n CollectionLengthUpperBound) String() string {
+	// TODO: implement
+	return "todo - CollectionLengthUpperBound"
+}
+
+// TODO: doc
+func (n CollectionLengthUpperBound) UpperBound() int64 {
+	return n.value
+}
+
+func (n CollectionLengthUpperBound) unimplementable() {}
+
+// TODO: doc
+func NewCollectionLengthUpperBound(value int64) Refinement {
+	return CollectionLengthUpperBound{
+		value: value,
+	}
+}

tftypes/refinement/doc.go

@@ -0,0 +1,5 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+// TODO: docs
+package refinement

tftypes/refinement/nullness.go

@@ -1,23 +1,31 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package refinement
 
+// TODO: doc
 type Nullness struct {
 	value bool
 }
 
 func (n Nullness) Equal(Refinement) bool {
+	// TODO: implement
 	return false
 }
 
 func (n Nullness) String() string {
+	// TODO: implement
 	return "todo - Nullness"
 }
 
+// TODO: doc
 func (n Nullness) Nullness() bool {
 	return n.value
 }
 
 func (n Nullness) unimplementable() {}
 
+// TODO: doc
 func NewNullness(value bool) Refinement {
 	return Nullness{
 		value: value,

tftypes/refinement/number_lower_bound.go

@@ -1,32 +1,41 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package refinement
 
 import (
 	"math/big"
 )
 
+// TODO: doc
 type NumberLowerBound struct {
 	inclusive bool
 	value     *big.Float
 }
 
 func (n NumberLowerBound) Equal(Refinement) bool {
+	// TODO: implement
 	return false
 }
 
 func (n NumberLowerBound) String() string {
+	// TODO: implement
 	return "todo - NumberLowerBound"
 }
 
+// TODO: doc
 func (n NumberLowerBound) IsInclusive() bool {
 	return n.inclusive
 }
 
+// TODO: doc
 func (n NumberLowerBound) LowerBound() *big.Float {
 	return n.value
 }
 
 func (n NumberLowerBound) unimplementable() {}
 
+// TODO: doc
 func NewNumberLowerBound(value *big.Float, inclusive bool) Refinement {
 	return NumberLowerBound{
 		value:     value,

tftypes/refinement/number_upper_bound.go

@@ -1,32 +1,41 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package refinement
 
 import (
 	"math/big"
 )
 
+// TODO: doc
 type NumberUpperBound struct {
 	inclusive bool
 	value     *big.Float
 }
 
 func (n NumberUpperBound) Equal(Refinement) bool {
+	// TODO: implement
 	return false
 }
 
 func (n NumberUpperBound) String() string {
+	// TODO: implement
 	return "todo - NumberUpperBound"
 }
 
+// TODO: doc
 func (n NumberUpperBound) IsInclusive() bool {
 	return n.inclusive
 }
 
+// TODO: doc
 func (n NumberUpperBound) UpperBound() *big.Float {
 	return n.value
 }
 
 func (n NumberUpperBound) unimplementable() {}
 
+// TODO: doc
 func NewNumberUpperBound(value *big.Float, inclusive bool) Refinement {
 	return NumberUpperBound{
 		value:     value,

tftypes/refinement/refinement.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package refinement
 
 import (
@@ -23,20 +26,56 @@ func (k Key) String() string {
 }
 
 const (
-	KeyNullness         = Key(1)
-	KeyStringPrefix     = Key(2)
+	// KeyNullness represents a refinement that specifies whether the final value will not be null.
+	//
+	// MAINTINAER NOTE: In practice, this refinement data will only contain "false", indicating the final value
+	// cannot be null. If the refinement data was ever set to "true", that would indicate the final value will be null, in which
+	// case the value is not unknown, it is known and should not have any refinement data.
+	//
+	// This refinement is relevant for all types except tftypes.DynamicPseudoType.
+	KeyNullness = Key(1)
+
+	// KeyStringPrefix represents a refinement that specifies a known prefix of a final string value.
+	//
+	// This refinement is only relevant for tftypes.String.
+	KeyStringPrefix = Key(2)
+
+	// KeyNumberLowerBound represents a refinement that specifies the lower bound of possible values for a final number value.
+	// The refinement data contains a boolean which indicates whether the bound is inclusive.
+	//
+	// This refinement is only relevant for tftypes.Number.
 	KeyNumberLowerBound = Key(3)
+
+	// KeyNumberUpperBound represents a refinement that specifies the upper bound of possible values for a final number value.
+	// The refinement data contains a boolean which indicates whether the bound is inclusive.
+	//
+	// This refinement is only relevant for tftypes.Number.
 	KeyNumberUpperBound = Key(4)
-	// KeyCollectionLengthLowerBound = Key(5)
-	// KeyCollectionLengthUpperBound = Key(6)
+
+	// KeyCollectionLengthLowerBound represents a refinement that specifies the lower bound of possible length for a final collection value.
+	//
+	// This refinement is only relevant for tftypes.List, tftypes.Set, and tftypes.Map.
+	KeyCollectionLengthLowerBound = Key(5)
+
+	// KeyCollectionLengthUpperBound represents a refinement that specifies the upper bound of possible length for a final collection value.
+	//
+	// This refinement is only relevant for tftypes.List, tftypes.Set, and tftypes.Map.
+	KeyCollectionLengthUpperBound = Key(6)
 )
 
+// TODO: docs
 type Refinement interface {
+	// Equal should return true if the Refinement is considered equivalent to the
+	// Refinement passed as an argument.
 	Equal(Refinement) bool
+
+	// String should return a human-friendly version of the Refinement.
 	String() string
+
 	unimplementable() // prevents external implementations, all refinements are defined in the Terraform/HCL type system go-cty.
 }
 
+// TODO: docs
 type Refinements map[Key]Refinement
 
 func (r Refinements) Equal(o Refinements) bool {

tftypes/refinement/string_prefix.go

@@ -1,23 +1,31 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package refinement
 
+// TODO: doc
 type StringPrefix struct {
 	value string
 }
 
 func (s StringPrefix) Equal(Refinement) bool {
+	// TODO: implement
 	return false
 }
 
 func (s StringPrefix) String() string {
+	// TODO: implement
 	return "todo - stringPrefix"
 }
 
+// TODO: doc
 func (s StringPrefix) PrefixValue() string {
 	return s.value
 }
 
 func (s StringPrefix) unimplementable() {}
 
+// TODO: doc
 func NewStringPrefix(value string) Refinement {
 	return StringPrefix{
 		value: value,