Remove default Encoding parameter values for future extensibility

austoonz · austoonz · commit 267d4a26cf03 · 2026-01-30T14:59:36.000-08:00
Move encoding defaults from parameter declarations to internal handling:
- Allows detection of whether user explicitly specified an encoding
- Enables future best-effort improvements when encoding is not provided
- All functions now use internal 'if ([string]::IsNullOrEmpty(\)) { \ = ''UTF8'' }'

Updated functions:
- ConvertFrom-Base64, ConvertFrom-MemoryStream, ConvertFrom-MemoryStreamToString
- ConvertFrom-MemoryStreamToSecureString, ConvertFrom-StringToBase64
- ConvertFrom-StringToByteArray, ConvertFrom-StringToCompressedByteArray
- ConvertFrom-StringToMemoryStream, ConvertTo-Base64, ConvertTo-Hash
- ConvertTo-HmacHash, ConvertTo-MemoryStream
diff --git a/src/Convert/Public/ConvertFrom-Base64.ps1 b/src/Convert/Public/ConvertFrom-Base64.ps1
@@ -72,7 +72,7 @@ function ConvertFrom-Base64 {
         [Parameter(ParameterSetName = 'ToString')]
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Parameter(ParameterSetName = 'ToString')]
         [Parameter(Mandatory = $false)]
@@ -88,6 +88,10 @@ function ConvertFrom-Base64 {
     begin {
         $userErrorActionPreference = $ErrorActionPreference
         $nullPtr = [IntPtr]::Zero
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-MemoryStream.ps1 b/src/Convert/Public/ConvertFrom-MemoryStream.ps1
@@ -158,7 +158,7 @@ function ConvertFrom-MemoryStream {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Parameter(ParameterSetName = 'ToString')]
         [Switch]
@@ -171,6 +171,10 @@ function ConvertFrom-MemoryStream {
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-MemoryStreamToSecureString.ps1 b/src/Convert/Public/ConvertFrom-MemoryStreamToSecureString.ps1
@@ -56,11 +56,15 @@ function ConvertFrom-MemoryStreamToSecureString {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8'
+        $Encoding
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-MemoryStreamToString.ps1 b/src/Convert/Public/ConvertFrom-MemoryStreamToString.ps1
@@ -94,11 +94,15 @@ function ConvertFrom-MemoryStreamToString {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8'
+        $Encoding
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-StringToBase64.ps1 b/src/Convert/Public/ConvertFrom-StringToBase64.ps1
@@ -72,7 +72,7 @@ function ConvertFrom-StringToBase64 {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Parameter(Mandatory = $false)]
         [Switch]
@@ -82,6 +82,10 @@ function ConvertFrom-StringToBase64 {
     begin {
         $userErrorActionPreference = $ErrorActionPreference
         $nullPtr = [IntPtr]::Zero
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-StringToByteArray.ps1 b/src/Convert/Public/ConvertFrom-StringToByteArray.ps1
@@ -66,11 +66,15 @@ function ConvertFrom-StringToByteArray {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8'
+        $Encoding
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-StringToCompressedByteArray.ps1 b/src/Convert/Public/ConvertFrom-StringToCompressedByteArray.ps1
@@ -47,12 +47,16 @@ function ConvertFrom-StringToCompressedByteArray {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8'
+        $Encoding
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
         $nullPtr = [IntPtr]::Zero
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertFrom-StringToMemoryStream.ps1 b/src/Convert/Public/ConvertFrom-StringToMemoryStream.ps1
@@ -91,14 +91,18 @@ function ConvertFrom-StringToMemoryStream {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Switch]
         $Compress
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertTo-Base64.ps1 b/src/Convert/Public/ConvertTo-Base64.ps1
@@ -164,7 +164,7 @@ function ConvertTo-Base64 {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Parameter(Mandatory = $false)]
         [Switch]
@@ -173,6 +173,10 @@ function ConvertTo-Base64 {
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
 
         $convertSplat = @{
             ErrorAction = $userErrorActionPreference
diff --git a/src/Convert/Public/ConvertTo-Hash.ps1 b/src/Convert/Public/ConvertTo-Hash.ps1
@@ -32,12 +32,16 @@ function ConvertTo-Hash {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8'
+        $Encoding
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
         $nullPtr = [IntPtr]::Zero
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
     }
 
     process {
diff --git a/src/Convert/Public/ConvertTo-HmacHash.ps1 b/src/Convert/Public/ConvertTo-HmacHash.ps1
@@ -111,7 +111,7 @@ function ConvertTo-HmacHash {
         [string]$Algorithm = 'HMACSHA256',
         
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
-        [String]$Encoding = 'UTF8',
+        [String]$Encoding,
         
         [ValidateSet('Hex', 'Base64', 'ByteArray')]
         [string]$OutputFormat = 'Hex',
@@ -124,6 +124,11 @@ function ConvertTo-HmacHash {
         $userErrorActionPreference = $ErrorActionPreference
         $generatedKey = $null
         
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
+        
         # Minimum recommended key lengths
         $minimumKeyLengths = @{
             'HMACSHA256' = 32  # 256 bits
diff --git a/src/Convert/Public/ConvertTo-MemoryStream.ps1 b/src/Convert/Public/ConvertTo-MemoryStream.ps1
@@ -91,14 +91,18 @@ function ConvertTo-MemoryStream {
 
         [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]
         [String]
-        $Encoding = 'UTF8',
+        $Encoding,
 
         [Switch]
         $Compress
     )
 
     begin {
         $userErrorActionPreference = $ErrorActionPreference
+        # Default to UTF8 if no encoding specified
+        if ([string]::IsNullOrEmpty($Encoding)) {
+            $Encoding = 'UTF8'
+        }
         $eaSplat = @{
             ErrorAction = $userErrorActionPreference
         }
diff --git a/src/Tests/Unit/ConvertTo-String.Tests.ps1 b/src/Tests/Unit/ConvertTo-String.Tests.ps1
@@ -48,8 +48,9 @@ Describe -Name $function -Fixture {
             $assertion | Should -BeOfType [string]
         }
 
-        It -Name 'Round-trips binary data through Latin-1 fallback' -Test {
-            $binaryBytes = [byte[]](0xA1, 0x59, 0xC0, 0xA5, 0xE4, 0x94, 0xFF, 0x00, 0x80)
+        It -Name 'Round-trips binary data through Latin-1 fallback (without null bytes)' -Test {
+            # Note: Null bytes (0x00) are replaced with replacement character for C string safety
+            $binaryBytes = [byte[]](0xA1, 0x59, 0xC0, 0xA5, 0xE4, 0x94, 0xFF, 0x80)
             $base64 = [System.Convert]::ToBase64String($binaryBytes)
             
             $resultString = ConvertTo-String -Base64EncodedString $base64

Original file line number	Diff line number	Diff line change
`@@ -56,11 +56,15 @@ function ConvertFrom-MemoryStreamToSecureString {`
`56`	`56`
`57`	`57`	`[ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]`
`58`	`58`	`[String]`
`59`		`- $Encoding = 'UTF8'`
	`59`	`+ $Encoding`
`60`	`60`	`)`
`61`	`61`
`62`	`62`	`begin {`
`63`	`63`	`$userErrorActionPreference = $ErrorActionPreference`
	`64`	`+ # Default to UTF8 if no encoding specified`
	`65`	`+ if ([string]::IsNullOrEmpty($Encoding)) {`
	`66`	`+ $Encoding = 'UTF8'`
	`67`	`+ }`
`64`	`68`	`}`
`65`	`69`
`66`	`70`	`process {`
Original file line number	Diff line number	Diff line change
`@@ -94,11 +94,15 @@ function ConvertFrom-MemoryStreamToString {`
`94`	`94`
`95`	`95`	`[ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]`
`96`	`96`	`[String]`
`97`		`- $Encoding = 'UTF8'`
	`97`	`+ $Encoding`
`98`	`98`	`)`
`99`	`99`
`100`	`100`	`begin {`
`101`	`101`	`$userErrorActionPreference = $ErrorActionPreference`
	`102`	`+ # Default to UTF8 if no encoding specified`
	`103`	`+ if ([string]::IsNullOrEmpty($Encoding)) {`
	`104`	`+ $Encoding = 'UTF8'`
	`105`	`+ }`
`102`	`106`	`}`
`103`	`107`
`104`	`108`	`process {`
Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,15 @@ function ConvertFrom-StringToByteArray {`
`66`	`66`
`67`	`67`	`[ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF8')]`
`68`	`68`	`[String]`
`69`		`- $Encoding = 'UTF8'`
	`69`	`+ $Encoding`
`70`	`70`	`)`
`71`	`71`
`72`	`72`	`begin {`
`73`	`73`	`$userErrorActionPreference = $ErrorActionPreference`
	`74`	`+ # Default to UTF8 if no encoding specified`
	`75`	`+ if ([string]::IsNullOrEmpty($Encoding)) {`
	`76`	`+ $Encoding = 'UTF8'`
	`77`	`+ }`
`74`	`78`	`}`
`75`	`79`
`76`	`80`	`process {`