encoder

Documentation

Overview

Package encoder contains data encoding and continuation token encoding implementations.

Index

• type Base64Encoder
  • func NewBase64Encoder() *Base64Encoder
  • func (e *Base64Encoder) Decode(s string) ([]byte, error)
  • func (e *Base64Encoder) Encode(data []byte) (string, error)
• type Encoder
• type NoopEncoder
  • func (e NoopEncoder) Decode(s string) ([]byte, error)
  • func (e NoopEncoder) Encode(data []byte) (string, error)
• type TokenEncoder
  • func NewTokenEncoder(encrypter encrypter.Encrypter, encoder Encoder) *TokenEncoder
  • func (e *TokenEncoder) Decode(s string) ([]byte, error)
  • func (e *TokenEncoder) Encode(data []byte) (string, error)

Types

type Base64Encoder

type Base64Encoder struct{}

Base64Encoder implements the Encoder interface by delegating to the encoding/base64 base64 encoding strategy.

func NewBase64Encoder

func NewBase64Encoder() *Base64Encoder

NewBase64Encoder constructs an Encoder that implements a base64 encoding as specified by the encoding/base64 package.

func (*Base64Encoder) Decode

func (e *Base64Encoder) Decode(s string) ([]byte, error)

Decode base64 URL decodes the provided string.

func (*Base64Encoder) Encode

func (e *Base64Encoder) Encode(data []byte) (string, error)

Encode base64 URL encodes the provided byte slice and returns the encoded value as a string.

type Encoder

type Encoder interface {
	Decode(string) ([]byte, error)
	Encode([]byte) (string, error)
}

type NoopEncoder

type NoopEncoder struct{}

func (NoopEncoder) Decode

func (e NoopEncoder) Decode(s string) ([]byte, error)

func (NoopEncoder) Encode

func (e NoopEncoder) Encode(data []byte) (string, error)

type TokenEncoder

type TokenEncoder struct {
	// contains filtered or unexported fields
}

func NewTokenEncoder

func NewTokenEncoder(encrypter encrypter.Encrypter, encoder Encoder) *TokenEncoder

NewTokenEncoder constructs a TokenEncoder with the provided encrypter and encoder.

func (*TokenEncoder) Decode

func (e *TokenEncoder) Decode(s string) ([]byte, error)

Decode will first decode the given string with its decoder, then decrypt the result with its decrypter.

func (*TokenEncoder) Encode

func (e *TokenEncoder) Encode(data []byte) (string, error)

Encode will first encrypt the given data with its encrypter, then encode the result with its encoder.