package ocf

Import Path
	github.com/hamba/avro/v2/ocf (on go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	    codec.go
	  d ocf.go
		Package ocf implements encoding and decoding of Avro Object Container Files as defined by the Avro specification.
		
		See the Avro specification for an understanding of Avro: http://avro.apache.org/docs/current/
Code Examples

	NewDecoder
		package main
		
		import (
			"log"
			"os"
		
			"github.com/hamba/avro/v2/ocf"
		)
		
		func main() {
			type SimpleRecord struct {
				A int64  `avro:"a"`
				B string `avro:"b"`
			}
		
			f, err := os.Open("/your/avro/file.avro")
			if err != nil {
				log.Fatal(err)
			}
			defer f.Close()
		
			dec, err := ocf.NewDecoder(f)
			if err != nil {
				log.Fatal(err)
			}
		
			for dec.HasNext() {
				var record SimpleRecord
				err = dec.Decode(&record)
				if err != nil {
					log.Fatal(err)
				}
		
				// Do something with the data
			}
		
			if err := dec.Error(); err != nil {
				log.Fatal(err)
			}
		}

	NewEncoder
		package main
		
		import (
			"log"
			"os"
		
			"github.com/hamba/avro/v2/ocf"
		)
		
		func main() {
			schema := `{
			    "type": "record",
			    "name": "simple",
			    "namespace": "org.hamba.avro",
			    "fields" : [
			        {"name": "a", "type": "long"},
			        {"name": "b", "type": "string"}
			    ]
			}`
		
			type SimpleRecord struct {
				A int64  `avro:"a"`
				B string `avro:"b"`
			}
		
			f, err := os.Open("/your/avro/file.avro")
			if err != nil {
				log.Fatal(err)
			}
			defer f.Close()
		
			enc, err := ocf.NewEncoder(schema, f)
			if err != nil {
				log.Fatal(err)
			}
		
			var record SimpleRecord
			err = enc.Encode(record)
			if err != nil {
				log.Fatal(err)
			}
		
			if err := enc.Flush(); err != nil {
				log.Fatal(err)
			}
		
			if err := f.Sync(); err != nil {
				log.Fatal(err)
			}
		}


Package-Level Type Names (total 11)

	/* sort by: alphabet | popularity */
	 type Codec (interface)
		Codec represents a compression codec.

		Methods (total 2)
			( Codec) Decode([]byte) ([]byte, error)
				Decode decodes the given bytes.

			( Codec) Encode([]byte) []byte
				Encode encodes the given bytes.

		Implemented By (at least 4)
			*DeflateCodec
			*NullCodec
			*SnappyCodec
			*ZStandardCodec

	 type CodecName string (basic type)
		CodecName represents a compression codec name.

		As Inputs Of (at least one exported)
			func WithCodec(codec CodecName) EncoderFunc
		As Types Of (total 4)
			const Deflate
			const Null
			const Snappy
			const ZStandard

	 type Decoder (struct)
		Decoder reads and decodes Avro values from a container file.

		Methods (total 5)
			(*Decoder) Decode(v any) error
				Decode reads the next Avro encoded value from its input and stores it in the value pointed to by v.

			(*Decoder) Error() error
				Error returns the last reader error.

			(*Decoder) HasNext() bool
				HasNext determines if there is another value to read.

			(*Decoder) Metadata() map[string][]byte
				Metadata returns the header metadata.

			(*Decoder) Schema() avro.Schema
				Schema returns the schema that was parsed from the file's metadata
				and that is used to interpret the file's contents.

		Implements (at least one exported)
			*Decoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Decoder
		As Outputs Of (at least one exported)
			func NewDecoder(r io.Reader, opts ...DecoderFunc) (*Decoder, error)

	 type DecoderFunc (func)
		DecoderFunc represents a configuration function for Decoder.

		As Outputs Of (at least 3)
			func WithDecoderConfig(wCfg avro.API) DecoderFunc
			func WithDecoderSchemaCache(cache *avro.SchemaCache) DecoderFunc
			func WithZStandardDecoderOptions(opts ...zstd.DOption) DecoderFunc
		As Inputs Of (at least one exported)
			func NewDecoder(r io.Reader, opts ...DecoderFunc) (*Decoder, error)

	 type DeflateCodec (struct)
		DeflateCodec is a flate compression codec.

		Methods (total 2)
			(*DeflateCodec) Decode(b []byte) ([]byte, error)
				Decode decodes the given bytes.

			(*DeflateCodec) Encode(b []byte) []byte
				Encode encodes the given bytes.

		Implements (at least one exported)
			*DeflateCodec : Codec

	 type Encoder (struct)
		Encoder writes Avro container file to an output stream.

		Methods (total 4)
			(*Encoder) Close() error
				Close closes the encoder, flushing the writer.

			(*Encoder) Encode(v any) error
				Encode writes the Avro encoding of v to the stream.

			(*Encoder) Flush() error
				Flush flushes the underlying writer.

			(*Encoder) Write(p []byte) (n int, err error)
				Write v to the internal buffer. This method skips the internal encoder and
				therefore the caller is responsible for encoding the bytes. No error will be
				thrown if the bytes does not conform to the schema given to NewEncoder, but
				the final ocf data will be corrupted.

		Implements (at least 9)
			*Encoder : github.com/apache/thrift/lib/go/thrift.Flusher
			*Encoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Encoder
			*Encoder : github.com/miekg/dns.Writer
			*Encoder : github.com/prometheus/common/expfmt.Closer
			*Encoder : go.uber.org/zap/zapcore.ReflectedEncoder
			*Encoder : internal/bisect.Writer
			*Encoder : io.Closer
			*Encoder : io.WriteCloser
			*Encoder : io.Writer
		As Outputs Of (at least 2)
			func NewEncoder(s string, w io.Writer, opts ...EncoderFunc) (*Encoder, error)
			func NewEncoderWithSchema(schema avro.Schema, w io.Writer, opts ...EncoderFunc) (*Encoder, error)

	 type EncoderFunc (func)
		EncoderFunc represents a configuration function for Encoder.

		As Outputs Of (at least 11)
			func WithBlockLength(length int) EncoderFunc
			func WithBlockSize(size int) EncoderFunc
			func WithCodec(codec CodecName) EncoderFunc
			func WithCompressionLevel(compLvl int) EncoderFunc
			func WithEncoderSchemaCache(cache *avro.SchemaCache) EncoderFunc
			func WithEncodingConfig(wCfg avro.API) EncoderFunc
			func WithMetadata(meta map[string][]byte) EncoderFunc
			func WithMetadataKeyVal(key string, val []byte) EncoderFunc
			func WithSchemaMarshaler(m func(avro.Schema) ([]byte, error)) EncoderFunc
			func WithSyncBlock(sync [16]byte) EncoderFunc
			func WithZStandardEncoderOptions(opts ...zstd.EOption) EncoderFunc
		As Inputs Of (at least 2)
			func NewEncoder(s string, w io.Writer, opts ...EncoderFunc) (*Encoder, error)
			func NewEncoderWithSchema(schema avro.Schema, w io.Writer, opts ...EncoderFunc) (*Encoder, error)

	 type Header (struct)
		Header represents an Avro container file header.

		Fields (total 3)
			Magic [4]byte
			Meta map[string][]byte
			Sync [16]byte

	 type NullCodec (struct)
		NullCodec is a no op codec.

		Methods (total 2)
			(*NullCodec) Decode(b []byte) ([]byte, error)
				Decode decodes the given bytes.

			(*NullCodec) Encode(b []byte) []byte
				Encode encodes the given bytes.

		Implements (at least one exported)
			*NullCodec : Codec

	 type SnappyCodec (struct)
		SnappyCodec is a snappy compression codec.

		Methods (total 2)
			(*SnappyCodec) Decode(b []byte) ([]byte, error)
				Decode decodes the given bytes.

			(*SnappyCodec) Encode(b []byte) []byte
				Encode encodes the given bytes.

		Implements (at least one exported)
			*SnappyCodec : Codec

	 type ZStandardCodec (struct)
		ZStandardCodec is a zstandard compression codec.

		Methods (total 2)
			(*ZStandardCodec) Decode(b []byte) ([]byte, error)
				Decode decodes the given bytes.

			(*ZStandardCodec) Encode(b []byte) []byte
				Encode encodes the given bytes.

		Implements (at least one exported)
			*ZStandardCodec : Codec


Package-Level Functions (total 17)

	 func NewDecoder(r io.Reader, opts ...DecoderFunc) (*Decoder, error)
		NewDecoder returns a new decoder that reads from reader r.

	 func NewEncoder(s string, w io.Writer, opts ...EncoderFunc) (*Encoder, error)
		NewEncoder returns a new encoder that writes to w using schema s.
		
		If the writer is an existing ocf file, it will append data using the
		existing schema.

	 func NewEncoderWithSchema(schema avro.Schema, w io.Writer, opts ...EncoderFunc) (*Encoder, error)
		NewEncoderWithSchema returns a new encoder that writes to w using schema s.
		
		If the writer is an existing ocf file, it will append data using the
		existing schema.

	 func WithBlockLength(length int) EncoderFunc
		WithBlockLength sets the block length on the encoder.

	 func WithBlockSize(size int) EncoderFunc
		WithBlockSize sets the maximum uncompressed size of a buffered block before
		it is written and flushed to the underlying io.Writer (after compression).

	 func WithCodec(codec CodecName) EncoderFunc
		WithCodec sets the compression codec on the encoder.

	 func WithCompressionLevel(compLvl int) EncoderFunc
		WithCompressionLevel sets the compression codec to deflate and
		the compression level on the encoder.

	 func WithDecoderConfig(wCfg avro.API) DecoderFunc
		WithDecoderConfig sets the value decoder config on the OCF decoder.

	 func WithDecoderSchemaCache(cache *avro.SchemaCache) DecoderFunc
		WithDecoderSchemaCache sets the schema cache for the decoder.
		If not specified, defaults to avro.DefaultSchemaCache.

	 func WithEncoderSchemaCache(cache *avro.SchemaCache) EncoderFunc
		WithEncoderSchemaCache sets the schema cache for the encoder.
		If not specified, defaults to avro.DefaultSchemaCache.

	 func WithEncodingConfig(wCfg avro.API) EncoderFunc
		WithEncodingConfig sets the value encoder config on the OCF encoder.

	 func WithMetadata(meta map[string][]byte) EncoderFunc
		WithMetadata sets the metadata on the encoder header.

	 func WithMetadataKeyVal(key string, val []byte) EncoderFunc
		WithMetadataKeyVal sets a single key-value pair for the metadata on
		the encoder header.

	 func WithSchemaMarshaler(m func(avro.Schema) ([]byte, error)) EncoderFunc
		WithSchemaMarshaler sets the schema marshaler for the encoder.
		If not specified, defaults to DefaultSchemaMarshaler.

	 func WithSyncBlock(sync [16]byte) EncoderFunc
		WithSyncBlock sets the sync block.

	 func WithZStandardDecoderOptions(opts ...zstd.DOption) DecoderFunc
		WithZStandardDecoderOptions sets the options for the ZStandard decoder.

	 func WithZStandardEncoderOptions(opts ...zstd.EOption) EncoderFunc
		WithZStandardEncoderOptions sets the options for the ZStandard encoder.


Package-Level Variables (total 3)

	  var DefaultSchemaMarshaler func(schema avro.Schema) ([]byte, error)
		DefaultSchemaMarshaler calls the schema's String() method, to produce
		a "canonical" schema.

	  var FullSchemaMarshaler func(schema avro.Schema) ([]byte, error)
		FullSchemaMarshaler calls the schema's MarshalJSON() method, to produce
		a schema with all details preserved. The "canonical" schema returned by
		the default marshaler does not preserve a type's extra properties.

	  var HeaderSchema avro.Schema
		HeaderSchema is the Avro schema of a container file header.


Package-Level Constants (total 4)

	const Deflate CodecName = "deflate"
		Supported compression codecs.

	const Null CodecName = "null"
		Supported compression codecs.

	const Snappy CodecName = "snappy"
		Supported compression codecs.

	const ZStandard CodecName = "zstandard"
		Supported compression codecs.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.