package quotedprintable

Import Path
	mime/quotedprintable (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d reader.go
		Package quotedprintable implements quoted-printable encoding as specified by
		RFC 2045.

	    writer.go
Code Examples

	NewReader
		package main
		
		import (
			"fmt"
			"io"
			"mime/quotedprintable"
			"strings"
		)
		
		func main() {
			for _, s := range []string{
				`=48=65=6C=6C=6F=2C=20=47=6F=70=68=65=72=73=21`,
				`invalid escape: <b style="font-size: 200%">hello</b>`,
				"Hello, Gophers! This symbol will be unescaped: =3D and this will be written in =\r\none line.",
			} {
				b, err := io.ReadAll(quotedprintable.NewReader(strings.NewReader(s)))
				fmt.Printf("%s %v\n", b, err)
			}
		}

	NewWriter
		package main
		
		import (
			"mime/quotedprintable"
			"os"
		)
		
		func main() {
			w := quotedprintable.NewWriter(os.Stdout)
			w.Write([]byte("These symbols will be escaped: = \t"))
			w.Close()
		
		}


Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Reader (struct)
		Reader is a quoted-printable decoder.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			br *bufio.Reader
			line []byte
				// to be consumed before more of br

			rerr error
				// last read error

		Methods (only one, which is exported)
			(*Reader) Read(p []byte) (n int, err error)
				Read reads and decodes quoted-printable data from the underlying reader.

		Implements (at least one exported)
			*Reader : io.Reader
		As Outputs Of (at least one exported)
			func NewReader(r io.Reader) *Reader

	 type Writer (struct)
		A Writer is a quoted-printable writer that implements [io.WriteCloser].

		Fields (total 5, in which 1 is exported)
			Binary bool
				Binary mode treats the writer's input as pure binary and processes end of
				line bytes as binary data.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			cr bool
			i int
			line [78]byte
			w io.Writer
		Methods (total 8, in which 2 are exported)
			(*Writer) Close() error
				Close closes the [Writer], flushing any unwritten data to the underlying
				[io.Writer], but does not close the underlying io.Writer.

			(*Writer) Write(p []byte) (n int, err error)
				Write encodes p using quoted-printable encoding and writes it to the
				underlying [io.Writer]. It limits line length to 76 characters. The encoded
				bytes are not necessarily flushed until the [Writer] is closed.

			/* 6 unexporteds ... *//* 6 unexporteds: */
			(*Writer) checkLastByte() error
				checkLastByte encodes the last buffered byte if it is a space or a tab.

			(*Writer) encode(b byte) error
			(*Writer) flush() error
			(*Writer) insertCRLF() error
			(*Writer) insertSoftLineBreak() error
			(*Writer) write(p []byte) error
				write limits text encoded in quoted-printable to 76 characters per line.

		Implements (at least 5, in which 4 are exported)
			*Writer : internal/bisect.Writer
			*Writer : io.Closer
			*Writer : io.WriteCloser
			*Writer : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			*Writer : crypto/tls.transcriptHash
		As Outputs Of (at least one exported)
			func NewWriter(w io.Writer) *Writer


Package-Level Functions (total 6, in which 2 are exported)

	 func NewReader(r io.Reader) *Reader
		NewReader returns a quoted-printable reader, decoding from r.

	 func NewWriter(w io.Writer) *Writer
		NewWriter returns a new [Writer] that writes to w.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 func fromHex(b byte) (byte, error)
	 func isQPDiscardWhitespace(r rune) bool
	 func isWhitespace(b byte) bool
	 func readHexByte(v []byte) (b byte, err error)
Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var crlf []byte
	  var lf []byte
	  var softSuffix []byte
Package-Level Constants (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const lineMaxLen = 76
	const upperhex = "0123456789ABCDEF"

The pages are generated with Golds v0.7.6. (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.