ascii85

Documentation

Overview

Package ascii85はbtoaツールやAdobeのPostScriptおよびPDFドキュメント形式で使用されているascii85データエンコーディングを実装しています。

Index

• func Decode(dst, src []byte, flush bool) (ndst, nsrc int, err error)
• func Encode(dst, src []byte) int
• func MaxEncodedLen(n int) int
• func NewDecoder(r io.Reader) io.Reader
• func NewEncoder(w io.Writer) io.WriteCloser
• type CorruptInputError
  • func (e CorruptInputError) Error() string

Functions

func Decode

func Decode(dst, src []byte, flush bool) (ndst, nsrc int, err error)

Decodeはsrcをdstにデコードし、dstへの書き込みバイト数とsrcから消費されたバイト数の両方を返します。 srcに無効なascii85データが含まれている場合、Decodeは正常に書き込まれたバイト数とCorruptInputErrorを返します。 Decodeはsrcのスペースと制御文字を無視します。 しばしば、ascii85でエンコードされたデータは<〜と〜>の記号で囲まれています。 Decodeは、これらが呼び出し元によって削除されていることを想定しています。

flushがtrueの場合、Decodeはsrcが入力ストリームの終わりを表し、別の32ビットブロックの完了を待つのではなく、完全に処理すると想定します。

NewDecoderはDecodeをio.Readerインターフェースにラップします。

func Encode

func Encode(dst, src []byte) int

Encodeはsrcを最大でdstの長さ(len(src))のバイト数までエンコードし、実際に書き込まれたバイト数を返します。

エンコーディングは4バイトのチャンクを扱い、最後のフラグメントには特殊なエンコーディングを使用するため、Encodeは大規模なデータストリームの個々のブロックには適していません。代わりにNewEncoder()を使用してください。

しばしば、ascii85でエンコードされたデータは<~と~>の記号で囲まれていますが、Encodeはこれを追加しません。

func MaxEncodedLen

func MaxEncodedLen(n int) int

MaxEncodedLenは、n個のソースバイトのエンコーディングの最大長を返します。

func NewDecoder

func NewDecoder(r io.Reader) io.Reader

NewDecoder は新しい ascii85 ストリームデコーダを構築します。

func NewEncoder

func NewEncoder(w io.Writer) io.WriteCloser

NewEncoderは新しいascii85ストリームエンコーダーを返します。返されたライターに書き込まれたデータはエンコードされ、wに書き込まれます。Ascii85エンコーディングは32ビットのブロックで動作します。書き込みが終了したら、呼び出し元は残りの部分ブロックをフラッシュするために返されたエンコーダーを閉じる必要があります。

Types

type CorruptInputError

type CorruptInputError int64

func (CorruptInputError) Error

func (e CorruptInputError) Error() string