refactor: rename ScaledDecimal to Decimal for consistency across the codebase

Author: RaphDal

buffer.go

@@ -573,7 +573,7 @@ func (b *buffer) Float64Column(name string, val float64) *buffer {
 	return b
 }
 
-func (b *buffer) DecimalColumn(name string, val ScaledDecimal) *buffer {
+func (b *buffer) DecimalColumn(name string, val Decimal) *buffer {
 	if val.isNull() {
 		// Don't write null decimals
 		return b
@@ -584,7 +584,7 @@ func (b *buffer) DecimalColumn(name string, val ScaledDecimal) *buffer {
 	return b.decimalColumn(name, val)
 }
 
-func (b *buffer) decimalColumn(name string, val ScaledDecimal) *buffer {
+func (b *buffer) decimalColumn(name string, val Decimal) *buffer {
 	if err := val.ensureValidScale(); err != nil {
 		b.lastErr = err
 		return b

buffer_test.go

@@ -501,7 +501,7 @@ func TestDecimalColumn(t *testing.T) {
 	prefix := []byte(testTable + " price==")
 	testCases := []struct {
 		name     string
-		value    qdb.ScaledDecimal
+		value    qdb.Decimal
 		expected []byte
 	}{
 		{
@@ -536,7 +536,7 @@ func TestDecimalColumnTrimmingAndPadding(t *testing.T) {
 
 	testCases := []struct {
 		name          string
-		value         qdb.ScaledDecimal
+		value         qdb.Decimal
 		expectedBytes []byte
 	}{
 		{

decimal.go

@@ -35,9 +35,8 @@ const (
 	maxDecimalScale       uint32 = 76
 )
 
-// ScaledDecimal represents a decimal value as a two's complement big-endian byte slice and a scale.
-// NULL decimals are represented by an offset of 32.
-type ScaledDecimal struct {
+// Decimal represents a decimal value as a two's complement big-endian byte slice and a scale.
+type Decimal struct {
 	scale    uint32
 	unscaled [32]byte
 	offset   uint8
@@ -48,19 +47,20 @@ type ShopspringDecimal interface {
 	Exponent() int32
 }
 
-// NewScaledDecimal constructs a decimal from a two's complement big-endian unscaled value and a scale.
+// NewDecimalUnsafe constructs a decimal from a two's complement big-endian unscaled value and a scale.
 // A nil/empty unscaled slice produces a NULL decimal.
-func NewScaledDecimal(unscaled []byte, scale uint32) (ScaledDecimal, error) {
+func NewDecimalUnsafe(unscaled []byte, scale uint32) (Decimal, error) {
 	if len(unscaled) == 0 {
-		return ScaledDecimal{
+		// NULL decimals are represented by an offset of 32.
+		return Decimal{
 			offset: 32,
 		}, nil
 	}
 	normalized, offset, err := normalizeTwosComplement(unscaled)
 	if err != nil {
-		return ScaledDecimal{}, err
+		return Decimal{}, err
 	}
-	return ScaledDecimal{
+	return Decimal{
 		scale:    scale,
 		unscaled: normalized,
 		offset:   offset,
@@ -69,43 +69,43 @@ func NewScaledDecimal(unscaled []byte, scale uint32) (ScaledDecimal, error) {
 
 // NewDecimal constructs a decimal from an arbitrary-precision integer and a scale.
 // Providing a nil unscaled value produces a NULL decimal.
-func NewDecimal(unscaled *big.Int, scale uint32) (ScaledDecimal, error) {
+func NewDecimal(unscaled *big.Int, scale uint32) (Decimal, error) {
 	if unscaled == nil {
-		return ScaledDecimal{
+		return Decimal{
 			offset: 32,
 		}, nil
 	}
 	unscaledRaw, offset, err := bigIntToTwosComplement(unscaled)
 	if err != nil {
-		return ScaledDecimal{}, err
+		return Decimal{}, err
 	}
-	return ScaledDecimal{
+	return Decimal{
 		scale:    scale,
 		unscaled: unscaledRaw,
 		offset:   offset,
 	}, nil
 }
 
 // NewDecimalFromInt64 constructs a decimal from a 64-bit integer and a scale.
-func NewDecimalFromInt64(unscaled int64, scale uint32) ScaledDecimal {
+func NewDecimalFromInt64(unscaled int64, scale uint32) Decimal {
 	var be [8]byte
 	binary.BigEndian.PutUint64(be[:], uint64(unscaled))
 	offset := trimTwosComplement(be[:])
 	payload := [32]byte{}
 	copy(payload[32-(8-offset):], be[offset:])
-	return ScaledDecimal{
+	return Decimal{
 		scale:    scale,
 		unscaled: payload,
 		offset:   uint8(32 - (8 - offset)),
 	}
 }
 
 // isNull reports whether the decimal represents NULL.
-func (d ScaledDecimal) isNull() bool {
+func (d Decimal) isNull() bool {
 	return d.offset >= 32
 }
 
-func (d ScaledDecimal) ensureValidScale() error {
+func (d Decimal) ensureValidScale() error {
 	if d.isNull() {
 		return nil
 	}
@@ -115,10 +115,10 @@ func (d ScaledDecimal) ensureValidScale() error {
 	return nil
 }
 
-func convertShopspringDecimal(value ShopspringDecimal) (ScaledDecimal, error) {
+func convertShopspringDecimal(value ShopspringDecimal) (Decimal, error) {
 	coeff := value.Coefficient()
 	if coeff == nil {
-		return ScaledDecimal{
+		return Decimal{
 			offset: 32,
 		}, nil
 	}

http_sender.go

@@ -315,7 +315,7 @@ func (s *httpLineSender) DecimalColumnShopspring(name string, val ShopspringDeci
 	return s
 }
 
-func (s *httpLineSender) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *httpLineSender) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.SetLastErr(errDecimalNotSupported)
 	return s
 }
@@ -662,7 +662,7 @@ func (s *httpLineSenderV2) DecimalColumnShopspring(name string, val ShopspringDe
 	return s
 }
 
-func (s *httpLineSenderV2) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *httpLineSenderV2) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.SetLastErr(errDecimalNotSupported)
 	return s
 }
@@ -727,7 +727,7 @@ func (s *httpLineSenderV3) Float64ArrayNDColumn(name string, values *NdArray[flo
 	return s
 }
 
-func (s *httpLineSenderV3) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *httpLineSenderV3) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.DecimalColumn(name, val)
 	return s
 }

interop_test.go

@@ -155,13 +155,13 @@ func execute(t *testing.T, ctx context.Context, sender qdb.LineSender, backCh ch
 }
 
 // parseDecimal64 quick and dirty parser for a decimal64 value from its string representation
-func parseDecimal64(s string) (qdb.ScaledDecimal, error) {
+func parseDecimal64(s string) (qdb.Decimal, error) {
 	// Remove whitespace
 	s = strings.TrimSpace(s)
 
 	// Check for empty string
 	if s == "" {
-		return qdb.ScaledDecimal{}, fmt.Errorf("empty string")
+		return qdb.Decimal{}, fmt.Errorf("empty string")
 	}
 
 	// Find the decimal point and remove it
@@ -173,7 +173,7 @@ func parseDecimal64(s string) (qdb.ScaledDecimal, error) {
 	// Parse the integer part
 	unscaled, err := strconv.ParseInt(s, 10, 64)
 	if err != nil {
-		return qdb.ScaledDecimal{}, err
+		return qdb.Decimal{}, err
 	}
 
 	scale := 0

sender.go

@@ -123,7 +123,7 @@ type LineSender interface {
 	// Column name cannot contain any of the following characters:
 	// '\n', '\r', '?', '.', ',', ”', '"', '\', '/', ':', ')', '(', '+',
 	// '-', '*' '%%', '~', or a non-printable char.
-	DecimalColumn(name string, val ScaledDecimal) LineSender
+	DecimalColumn(name string, val Decimal) LineSender
 
 	// DecimalColumnShopspring adds a decimal column value to the ILP message.
 	//

sender_pool.go

@@ -324,7 +324,7 @@ func (ps *pooledSender) DecimalColumnShopspring(name string, val ShopspringDecim
 	return ps
 }
 
-func (ps *pooledSender) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (ps *pooledSender) DecimalColumn(name string, val Decimal) LineSender {
 	ps.wrapped.DecimalColumn(name, val)
 	return ps
 }

tcp_sender.go

@@ -213,7 +213,7 @@ func (s *tcpLineSender) DecimalColumnShopspring(name string, val ShopspringDecim
 	return s
 }
 
-func (s *tcpLineSender) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *tcpLineSender) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.SetLastErr(errDecimalNotSupported)
 	return s
 }
@@ -391,7 +391,7 @@ func (s *tcpLineSenderV2) DecimalColumnShopspring(name string, val ShopspringDec
 	return s
 }
 
-func (s *tcpLineSenderV2) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *tcpLineSenderV2) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.SetLastErr(errDecimalNotSupported)
 	return s
 }
@@ -461,7 +461,7 @@ func (s *tcpLineSenderV3) DecimalColumnFromString(name string, val string) LineS
 	return s
 }
 
-func (s *tcpLineSenderV3) DecimalColumn(name string, val ScaledDecimal) LineSender {
+func (s *tcpLineSenderV3) DecimalColumn(name string, val Decimal) LineSender {
 	s.buf.DecimalColumn(name, val)
 	return s
 }