waratuman / elm-coder

An encoder and decoder of Base64, Base32, and Base16 for Elm

Elm Coder

An encoder and decoder for Base64, Base32 and Base16 (Hexadecimal).

Example

import Base32 exposing (decode, encode)


encodeFooBar =
    ("foobar"
        |> String.toList
        |> List.map Char.toCode
        |> encode
    )
        == Ok "Zm9vYmFy"


decodeFooBar =
    ("Zm9vYmFy"
        |> decode
        |> Result.map (List.map Char.fromCode >> String.fromList)
    )
        == Ok "foobar"

elm-coder's Issues

Drop Result from return type for encode functions

All currently implemented schemes (base16, base32 and base64) are defined for arbitrary sequences of bytes and encoding should never fail. In contrast, all encode functions currently return a Result String String which makes working with this package more clunky than necessary.

From my understanding, the Result type is used internally in an abstraction (intToChar) that allows to generically implement different Schemes using common core code.

I understand that there is some unsafety involved since there is no Byte type that can ensure users only call encode with a list of valid bytes (integers from 0x00 to 0xFF).

There is some precedent in other packages (https://github.com/rtfeldman/elm-hex/blob/master/src/Hex.elm#L138) that provide functions prefixed with unsafe that require users to pass in only valid values in cases where Elm's type-system cannot enforce them. This allows a more pragmatic API.

Would it be possible to re-implement the public API so that encode-type functions do not return a Result String String? This might be an issue when this package supports more Schemes in the future that can fail while encoding.

I'd be happy to discuss this further! :)

Please update elm-community/list-extra

I'm trying to use this library via elm-jsonwebtoken
https://github.com/ktonon/elm-jsonwebtoken/blob/1.0.2/elm-package.json

But it clashes with another of my dependencies, that is already using a newer version of elm-community/list-extra. Causing me to not be able to install anything.