codec

package

v1.0.5 Latest Latest Go to latest Published: Mar 19, 2025 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Suhaibinator/SRouter

Links

Documentation ¶

Overview ¶

Package codec provides encoding and decoding functionality for different data formats.

Index ¶

func DecodeBase62(encoded string) ([]byte, error)
func DecodeBase64(encoded string) ([]byte, error)
type JSONCodec
- func NewJSONCodec[T any, U any]() *JSONCodec[T, U]
- func (c *JSONCodec[T, U]) Decode(r *http.Request) (T, error)
- func (c *JSONCodec[T, U]) Encode(w http.ResponseWriter, resp U) error
type ProtoCodec
- func NewProtoCodec[T proto.Message, U proto.Message]() *ProtoCodec[T, U]
- func (c *ProtoCodec[T, U]) Decode(r *http.Request) (T, error)
- func (c *ProtoCodec[T, U]) Encode(w http.ResponseWriter, resp U) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DecodeBase62 ¶ added in v1.0.5

func DecodeBase62(encoded string) ([]byte, error)

DecodeBase62 decodes a base62-encoded string to bytes. Base62 is a subset of base64 that uses only alphanumeric characters (A-Z, a-z, 0-9). This encoding is useful for URLs and other contexts where special characters might cause issues. This function is used by the router when processing requests with Base62QueryParameter or Base62PathParameter source types.

Parameters:

encoded: The base62-encoded string to decode

Returns:

[]byte: The decoded bytes
error: An error if the input is not valid base62 or if decoding is not implemented

func DecodeBase64 ¶ added in v1.0.5

func DecodeBase64(encoded string) ([]byte, error)

DecodeBase64 decodes a base64-encoded string to bytes. It uses the standard base64 encoding as defined in RFC 4648. This function is used by the router when processing requests with Base64QueryParameter or Base64PathParameter source types.

Parameters:

encoded: The base64-encoded string to decode

Returns:

[]byte: The decoded bytes
error: An error if the input is not valid base64

Types ¶

type JSONCodec ¶

type JSONCodec[T any, U any] struct {
}

JSONCodec is a codec that uses JSON for marshaling and unmarshaling. It implements the Codec interface for encoding responses and decoding requests.

func NewJSONCodec ¶

func NewJSONCodec[T any, U any]() *JSONCodec[T, U]

NewJSONCodec creates a new JSONCodec instance for the specified types. T represents the request type and U represents the response type.

func (*JSONCodec[T, U]) Decode ¶

func (c *JSONCodec[T, U]) Decode(r *http.Request) (T, error)

Decode decodes the request body into a value of type T. It reads the entire request body and unmarshals it from JSON.

func (*JSONCodec[T, U]) Encode ¶

func (c *JSONCodec[T, U]) Encode(w http.ResponseWriter, resp U) error

Encode encodes a value of type U into the response. It marshals the value to JSON and writes it to the response with the appropriate content type.

type ProtoCodec ¶

type ProtoCodec[T proto.Message, U proto.Message] struct{}

Force T to be a pointer to a type implementing proto.Message.

func NewProtoCodec ¶

func NewProtoCodec[T proto.Message, U proto.Message]() *ProtoCodec[T, U]

NewProtoCodec creates a new ProtoCodec instance.

func (*ProtoCodec[T, U]) Decode ¶

func (c *ProtoCodec[T, U]) Decode(r *http.Request) (T, error)

Decode reads the request body and unmarshals into T (which is a pointer).

func (*ProtoCodec[T, U]) Encode ¶

func (c *ProtoCodec[T, U]) Encode(w http.ResponseWriter, resp U) error

Encode marshals U (also a pointer type) and writes to response.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL