pbio

Documentation

Overview

Package pbio 读写带有 varint 前缀的 protobuf 消息，使用 Google 的 Protobuf 包。

Package pbio 提供了带有 varint 前缀的 protobuf 消息读写功能。 本代码改编自 gogo/protobuf，使用 multiformats/go-varint 实现高效、可互操作的长度前缀。

Go 语言的 Protocol Buffers 增强版

版权所有 (c) 2013, GoGo 作者保留所有权利。 http://github.com/gogo/protobuf

在遵循以下条件的情况下，允许以源代码和二进制形式重新分发和使用，无论是否修改:

• 源代码的重新分发必须保留上述版权声明

本声明、以下条件和免责声明。

• 二进制形式的重新分发必须在随分发提供的文档和/或其他材料中复制上述

版权声明、本条件列表和以下免责声明。

本软件由版权所有者和贡献者"按原样"提供，不提供任何明示或暗示的保证，包括但不限于对适销性和特定用途适用性的保证。 在任何情况下，版权所有者或贡献者均不对任何直接、间接、偶然、特殊、惩戒性或后果性损害(包括但不限于采购替代商品或服务；使用、数据或利润损失； 或业务中断)承担责任，无论是基于合同、严格责任或侵权(包括疏忽或其他)的任何责任理论，即使事先被告知可能发生此类损害。

Package pbio 提供了带有 varint 前缀的 protobuf 消息读写功能。 本代码改编自 gogo/protobuf，使用 multiformats/go-varint 实现高效、可互操作的长度前缀。

Go 语言的 Protocol Buffers 增强版

版权所有 (c) 2013, GoGo 作者保留所有权利。 http://github.com/gogo/protobuf

在遵循以下条件的情况下，允许以源代码和二进制形式重新分发和使用，无论是否修改:

• 源代码的重新分发必须保留上述版权声明

本声明、以下条件和免责声明。

• 二进制形式的重新分发必须在随分发提供的文档和/或其他材料中复制上述

版权声明、本条件列表和以下免责声明。

本软件由版权所有者和贡献者"按原样"提供，不提供任何明示或暗示的保证，包括但不限于对适销性和特定用途适用性的保证。 在任何情况下，版权所有者或贡献者均不对任何直接、间接、偶然、特殊、惩戒性或后果性损害(包括但不限于采购替代商品或服务；使用、数据或利润损失； 或业务中断)承担责任，无论是基于合同、严格责任或侵权(包括疏忽或其他)的任何责任理论，即使事先被告知可能发生此类损害。

Index

• type ReadCloser
  • func NewDelimitedReader(r io.Reader, maxSize int) ReadCloser
• type Reader
• type WriteCloser
  • func NewDelimitedWriter(w io.Writer) WriteCloser
• type Writer

Types

type ReadCloser

type ReadCloser interface {
	Reader
	io.Closer
}

ReadCloser 组合了 Reader 和 io.Closer 接口

func NewDelimitedReader

func NewDelimitedReader(r io.Reader, maxSize int) ReadCloser

NewDelimitedReader 创建一个新的带分隔符的读取器 参数:

• r: 底层读取器
• maxSize: 允许的最大消息大小

返回值:

• ReadCloser: 读取器接口

type Reader

type Reader interface {
	// ReadMsg 读取一个 protobuf 消息
	// 参数:
	//   - msg: 用于存储读取结果的消息对象
	//
	// 返回值:
	//   - error: 错误信息
	ReadMsg(msg proto.Message) error
}

Reader 定义了读取 protobuf 消息的接口

type WriteCloser

type WriteCloser interface {
	Writer
	io.Closer
}

WriteCloser 组合了 Writer 和 io.Closer 接口

func NewDelimitedWriter

func NewDelimitedWriter(w io.Writer) WriteCloser

NewDelimitedWriter 创建一个新的带分隔符的写入器 参数:

• w: 底层写入器

返回值:

• WriteCloser: 写入器接口

type Writer

type Writer interface {
	// WriteMsg 写入一个 protobuf 消息
	// 参数:
	//   - proto.Message: 要写入的消息
	//
	// 返回值:
	//   - error: 错误信息
	WriteMsg(proto.Message) error
}

Writer 定义了写入 protobuf 消息的接口