package ascii85

Import Path
	encoding/ascii85 (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 0 packages

Involved Source Files

	  d ascii85.go
		Package ascii85 implements the ascii85 data encoding
		as used in the btoa tool and Adobe's PostScript and PDF document formats.
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type CorruptInputError int64 (basic type)

		Methods (only one)
			( CorruptInputError) Error() string
		Implements (at least one exported)
			 CorruptInputError : error


Package-Level Functions (total 5)

	 func Decode(dst, src []byte, flush bool) (ndst, nsrc int, err error)
		Decode decodes src into dst, returning both the number
		of bytes written to dst and the number consumed from src.
		If src contains invalid ascii85 data, Decode will return the
		number of bytes successfully written and a [CorruptInputError].
		Decode ignores space and control characters in src.
		Often, ascii85-encoded data is wrapped in <~ and ~> symbols.
		Decode expects these to have been stripped by the caller.
		
		If flush is true, Decode assumes that src represents the
		end of the input stream and processes it completely rather
		than wait for the completion of another 32-bit block.
		
		[NewDecoder] wraps an [io.Reader] interface around Decode.

	 func Encode(dst, src []byte) int
		Encode encodes src into at most [MaxEncodedLen](len(src))
		bytes of dst, returning the actual number of bytes written.
		
		The encoding handles 4-byte chunks, using a special encoding
		for the last fragment, so Encode is not appropriate for use on
		individual blocks of a large data stream. Use [NewEncoder] instead.
		
		Often, ascii85-encoded data is wrapped in <~ and ~> symbols.
		Encode does not add these.

	 func MaxEncodedLen(n int) int
		MaxEncodedLen returns the maximum length of an encoding of n source bytes.

	 func NewDecoder(r io.Reader) io.Reader
		NewDecoder constructs a new ascii85 stream decoder.

	 func NewEncoder(w io.Writer) io.WriteCloser
		NewEncoder returns a new ascii85 stream encoder. Data written to
		the returned writer will be encoded and then written to w.
		Ascii85 encodings operate in 32-bit blocks; when finished
		writing, the caller must Close the returned encoder to flush any
		trailing partial block.

The pages are generated with Golds v0.7.0-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.