Categorygithub.com/proio-org/go-proio
modulepackage
0.7.0
Repository: https://github.com/proio-org/go-proio.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
17
Dependents
4
Files
985 SLOC

# README

proio for Go

Build Status codecov Codacy Badge

Please see the main proio repository for general information on proio.

API

API documentation is provided by godoc.org

GoDoc

Installation

go-proio and included command-line tools are go get-able. Make sure you have the go compiler installed and set up:

go get github.com/proio-org/go-proio/...

If you do not have the go compiler, you can find pre-compiled binaries for the tools in the releases.

For information on what versions of Go are supported, please see the Travis CI page.

Examples

# Packages

No description provided by the author

# Functions

CopyEvent copies an Event.
Create makes a new file specified by filename, overwriting any existing file, and returns a Writer for the file.
NewEvent is required for constructing an Event.
NewReader wraps an existing io.Reader for reading proio Events.
NewWriter takes an io.Writer and wraps it in a new proio Writer.
Open opens the given existing file (in read-only mode), returning an error where appropriate.
StoredFileDescriptorProtos returns a slice of protobuf messages that represent all of the entry types collected by reading files or looking up FileDescriptorProtos from memory.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Event contains all data for an event, and provides methods for adding and retrieving data.
Reader serves to read Events from a stream in the proio format.
Writer serves to write Events into a stream in the proio format.

# Type aliases

No description provided by the author