Add performance note.

master
klauspost 2015-10-27 14:54:40 +01:00
parent e05cf9c197
commit 64a2a9b848
1 changed files with 3 additions and 0 deletions

View File

@ -21,6 +21,9 @@ import (
// StreamEncoder is an interface to encode Reed-Salomon parity sets for your data.
// It provides a fully streaming interface, and processes data in blocks of up to 4MB.
//
// For small shard sizes, 10MB and below, it is recommended to use the in-memory interface,
// since the streaming interface has a start up overhead.
type StreamEncoder interface {
// Encodes parity shards for a set of data shards.
// Input is 'shards' containing readers for data shards followed by parity shards