std/encoding/base64

Index

Variables
fn NewEncoder(mut enc: &Encoding, mut w: io::Writer): io::WriteCloser
fn NewDecoder(mut enc: &Encoding, mut r: io::Reader): io::Reader
type CorruptInputError
    fn Str(*self): str
struct Encoding
    fn New(encoder: str): &Encoding
    fn EncodedLen(*self, n: int): int
    fn DecodedLen(*self, n: int): int
    fn Clone(*self): &Encoding
    fn WithPadding(mut &self, padding: rune): &Encoding
    fn Strict(mut &self): &Encoding
    fn Encode(*self, mut dst: []byte, src: []byte)
    fn AppendEncode(*self, mut dst: []byte, src: []byte): []byte
    fn EncodeToStr(*self, src: []byte): str
    fn Decode(*self, mut dst: []byte, src: []byte)!: (n: int)
    fn AppendDecode(*self, mut dst: []byte, src: []byte)!: []byte
    fn DecodeStr(*self, s: str)!: []byte

Variables

const (
	StdPadding: rune = '=' // Standard padding character
	NoPadding:  rune = -1  // No padding
)

---

let mut StdEncoding = Encoding.New("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/")

The standard base64 encoding, as defined in RFC 4648. Mutation is undefined behavior.

---

let mut URLEncoding = Encoding.New("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_")

The alternate base64 encoding defined in RFC 4648. It is typically used in URLs and file names. Mutation is undefined behavior.

---

let mut RawStdEncoding = StdEncoding.Clone().WithPadding(NoPadding)

The standard raw, unpadded base64 encoding, as defined in RFC 4648 section 3.2. This is the same as [StdEncoding] but omits padding characters. Mutation is undefined behavior.

---

let mut RawURLEncoding = URLEncoding.Clone().WithPadding(NoPadding)

The unpadded alternate base64 encoding defined in RFC 4648. It is typically used in URLs and file names. This is the same as [URLEncoding] but omits padding characters. Mutation is undefined behavior.

NewEncoder

fn NewEncoder(mut enc: &Encoding, mut w: io::Writer): io::WriteCloser

NewEncoder returns a new base64 stream encoder. Data written to the returned writer will be encoded using enc and then written to w. Base64 encodings operate in 4-byte blocks; when finished writing, the caller must Close the returned encoder to flush any partially written blocks.

NewDecoder

fn NewDecoder(mut enc: &Encoding, mut r: io::Reader): io::Reader

Returns a new base64 stream decoder.

CorruptInputError

type CorruptInputError: i64

Str

fn Str(*self): str

Encoding

struct Encoding {
	// NOTE: contains filtered hidden or unexported fields
}

A radix 64 encoding/decoding scheme, defined by a 64-character alphabet. The most common encoding is the "base64" encoding defined in RFC 4648 and used in MIME (RFC 2045) and PEM (RFC 1421). RFC 4648 also defines an alternate encoding, which is the standard encoding with - and _ substituted for + and /.

New

fn New(encoder: str): &Encoding

Returns a new padded Encoding defined by the given alphabet, which must be a 64-byte string that contains unique byte values and does not contain the padding character or CR / LF ('\r', '\n'). The alphabet is treated as a sequence of byte values without any special treatment for multi-byte UTF-8. The resulting Encoding uses the default padding character ('='), which may be changed or disabled via [Encoding.WithPadding].

EncodedLen

fn EncodedLen(*self, n: int): int

Returns the length in bytes of the base64 encoding of an input buffer of length n.

DecodedLen

fn DecodedLen(*self, n: int): int

Returns the maximum length in bytes of the decoded data corresponding to n bytes of base64-encoded data.

Clone

fn Clone(*self): &Encoding

Returns clone of the self.

WithPadding

fn WithPadding(mut &self, padding: rune): &Encoding

Sets encoding padding to a specified padding character, or [NoPadding] to disable padding. The padding character must not be '\r' or '\n', must not be contained in the encoding's alphabet, must not be negative, and must be a rune equal or below '\xff'. Padding characters above '\x7f' are encoded as their exact byte value rather than using the UTF-8 representation of the codepoint.

Returns self.

Strict

fn Strict(mut &self): &Encoding

Sets strict decoding enabled. In this mode, the decoder requires that trailing padding bits are zero, as described in RFC 4648 section 3.5.

Note that the input is still malleable, as new line characters (CR and LF) are still ignored.

Returns self.

Encode

fn Encode(*self, mut dst: []byte, src: []byte)

Encodes src using the encoding self, writing [Encoding.EncodedLen](len(src)) bytes to dst.

The encoding pads the output to a multiple of 4 bytes, so Encode is not appropriate for use on individual blocks of a large data stream. Use [NewEncoder] instead.

AppendEncode

fn AppendEncode(*self, mut dst: []byte, src: []byte): []byte

Appends the base64 encoded src to dst and returns the extended buffer.

EncodeToStr

fn EncodeToStr(*self, src: []byte): str

Returns the base64 encoding of src.

Decode

fn Decode(*self, mut dst: []byte, src: []byte)!: (n: int)

Decodes src using the encoding self. It writes at most [Encoding.DecodedLen](len(src)) bytes to dst and returns the number of bytes written. The caller must ensure that dst is large enough to hold all the decoded data. If src contains invalid base64 data, it will return the number of bytes successfully written and [CorruptInputError]. New line characters (\r and \n) are ignored.

AppendDecode

fn AppendDecode(*self, mut dst: []byte, src: []byte)!: []byte

Appends the base64 decoded src to dst and returns the extended buffer. If the input is malformed, it returns the partially decoded src and an error. New line characters (\r and \n) are ignored.

DecodeStr

fn DecodeStr(*self, s: str)!: []byte

Returns the bytes represented by the base64 string s. If the input is malformed, it returns the partially decoded data and [CorruptInputError]. New line characters (\r and \n) are ignored.