[{"name":"Tar","comment":" Use\n\nencodeMetaData\n\n       createArchive : List ( MetaData, Data ) -> Bytes\n\nto create4 a tar archive from arbitrary set of files which may contain either text or binary\ndata. To extract files from an archive, imitate this example:\n\n       extractArchive testArchive\n\nFor more details, see the README. See also the demo app `./examples/Main.elm`\n\n@docs Data, MetaData, createArchive, extractArchive, testArchive, encodeFiles, encodeTextFile, encodeTextFiles, defaultMetadata\n\n","unions":[{"name":"Data","comment":" Use `StringData String` for text data,\n`BinaryData Bytes` for binary data, e.g.,\n`StringData \"This is a test\"` or\n`BinaryData someBytes`\n","args":[],"cases":[["StringData",["String.String"]],["BinaryData",["Bytes.Bytes"]]]}],"aliases":[{"name":"MetaData","comment":" A MetaData value contains the information, e.g.,\nfile name and file length, needed to construct the header\nfor a file in the tar archive. You may use `defaultMetadata` as\na starting point, modifying only what is needed.\n","args":[],"type":"{ filename : String.String, mode : Tar.Mode, ownerID : Basics.Int, groupID : Basics.Int, fileSize : Basics.Int, lastModificationTime : Basics.Int, linkIndicator : Tar.Link, linkedFileName : String.String, userName : String.String, groupName : String.String, fileNamePrefix : String.String }"}],"values":[{"name":"createArchive","comment":" Example:\n\n> data1 = ( { defaultMetadata | filename = \"one.txt\" }, StringData \"One\" )\n> data2 = ( { defaultMetadata | filename = \"two.txt\" }, StringData \"Two\" )\n> createArchive [data1, data2]\n\n> createArchive [data1, data2]\n> <3072 bytes> : Bytes.Bytes\n\n","type":"List.List ( Tar.MetaData, Tar.Data ) -> Bytes.Bytes"},{"name":"defaultMetadata","comment":" defaultMetadata is a dummy MetaData value that you modify\nto suit your needs. It contains a lot of boilerplates\n\nExample\n\nmetaData= { defaultMetadata | filename = \"Test.txt\" }\n\nSee the definition of MetaData to see what other fields you\nmay want to modify, or see `/examples/Main.elm`.\n\n","type":"Tar.MetaData"},{"name":"encodeFiles","comment":"\n\n      Example\n\n      import Tar exposing(defaultMetadata)\n\n      metaData_ =\n          defaultMetadata\n\n      metaData1 =\n          { metaData_ | filename = \"a.txt\" }\n\n      content1 =\n          \"One two three\\n\"\n\n      metaData2\n          { metaData_ | filename = \"c.binary\" }\n\n      content2 =\n          Hex.toBytes \"1234\" |> Maybe.withDefault (encode (Bytes.Encode.unsignedInt8 0))\n\n      Tar.encodeFiles\n          [ ( metaData1, StringData content1 )\n          , ( metaData2, BinaryData content2 )\n          ]\n          |> Bytes.Encode.encode\n\n      Note: `Hex` is found in `jxxcarlson/hex`\n\n","type":"List.List ( Tar.MetaData, Tar.Data ) -> Bytes.Encode.Encoder"},{"name":"encodeTextFile","comment":" Example:\n\n> encodeTextFile defaultMetadata \"Test!\" |> encode\n> <1024 bytes> : Bytes.Bytes\n\n","type":"Tar.MetaData -> String.String -> Bytes.Encode.Encoder"},{"name":"encodeTextFiles","comment":" Example\n\nencodeFiles [(defaultMetadata, \"This is a test\"), (defaultMetadata, \"Lah di dah do day!\")] |> Bytes.Encode.encode == <2594 bytes> : Bytes\n\n","type":"List.List ( Tar.MetaData, String.String ) -> Bytes.Encode.Encoder"},{"name":"extractArchive","comment":" Try\n\n> import Tar exposing(..)\n> extractArchive testArchive\n\nto test this function\n\n","type":"Bytes.Bytes -> List.List ( Tar.MetaData, Tar.Data )"},{"name":"testArchive","comment":" A small tar archive for testing purposes\n","type":"Bytes.Bytes"}],"binops":[]}]