encoding

Documentation

Overview

*

• Copyright 2024 DWANGO Co., Ltd. *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• https://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2024 DWANGO Co., Ltd. *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• https://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

*

• Copyright 2024 DWANGO Co., Ltd. *
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *
• https://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

Index

• Variables
• type EncodeAndDecoder
  • func NewEncodeAndDecoder(t TextType) (EncodeAndDecoder, error)
• type TextType

Variables

var (
	ErrUnsupportedTextType     = errors.New("unsupported text type")
	ErrFailedToEncodeAndDecode = errors.New("failed to encode and decode")
)

Define errors

Types

type EncodeAndDecoder

type EncodeAndDecoder interface {
	EncodeAndDecode(b []byte) ([]byte, error)
}

EncodeAndDecoder is an interface that provides encoding and decoding functionality.

func NewEncodeAndDecoder

func NewEncodeAndDecoder(t TextType) (EncodeAndDecoder, error)

type TextType

type TextType string

const (
	TextTypeJSON      TextType = "json"
	TextTypeJSONArray TextType = "json-array"
	TextTypeYAML      TextType = "yaml"
	TextTypeYAMLArray TextType = "yaml-array"
	TextTypeYAMLDocs  TextType = "yaml-docs"
)

Define text types