Golint cleanup from top level

This commit is contained in:
Harshavardhana
2015-03-05 21:09:16 -08:00
parent 540723d7ae
commit c00d1461b9
8 changed files with 56 additions and 31 deletions

View File

@@ -24,8 +24,10 @@ import (
"io"
)
// Metadata map
type Metadata map[string]string
// DataHeader struct
type DataHeader struct {
Key string
Part uint8
@@ -33,13 +35,16 @@ type DataHeader struct {
EncoderParams EncoderParams
}
// EncoderTechnique type
type EncoderTechnique int
// EncoderTechniques
const (
Vandermonde EncoderTechnique = iota
Cauchy
)
// EncoderParams struct
type EncoderParams struct {
Length uint32
K uint8
@@ -47,7 +52,7 @@ type EncoderParams struct {
Technique EncoderTechnique
}
// populate new header
// NewHeader populate new header
func NewHeader(key string, part uint8, metadata Metadata, encoderParams EncoderParams) DataHeader {
header := DataHeader{}
header.Key = key
@@ -62,7 +67,7 @@ func NewHeader(key string, part uint8, metadata Metadata, encoderParams EncoderP
return header
}
// validate populated header
// ValidateHeader validate populated header
func ValidateHeader(header DataHeader) bool {
if header.Key == "" || header.Part < 0 || len(header.Metadata) < 2 {
return false
@@ -75,7 +80,7 @@ func ValidateHeader(header DataHeader) bool {
return true
}
// Write data, returns error upon any failure
// WriteData write data, returns error upon any failure
func WriteData(target io.Writer, header DataHeader, data io.Reader) error {
if !ValidateHeader(header) {
return fmt.Errorf("Invalid header")

View File

@@ -44,30 +44,49 @@ import (
*/
// Magic list
var (
MagicMINI = binary.LittleEndian.Uint32([]byte{'M', 'I', 'N', 'I'})
MagicDATA = binary.LittleEndian.Uint32([]byte{'D', 'A', 'T', 'A'})
MagicINIM = binary.LittleEndian.Uint32([]byte{'I', 'N', 'I', 'M'})
)
// DonutFrameHeader -
// --------------
// BlockStart uint32
// VersionMajor uint32
// Reserved uint64
// DataLen uint64
// --------------
type DonutFrameHeader struct {
MagicMINI uint32
Version uint32
Reserved uint64
DataLength uint64
}
// Crc32c checksum
type Crc32c uint32
// Sha512 checksum
type Sha512 [sha512.Size]byte
// DonutFrameFooter -
// --------------
// DataSha512 [64]byte
// BlockLen uint64
// BlockEnd uint32
// --------------
type DonutFrameFooter struct {
DataSha512 Sha512
OffsetToMINI uint64
MagicINIM uint32
}
// Data buffer
type Data bytes.Buffer
// Write Donut format to input io.Writer, returns error upon any failure
// WriteFrame - write donut format to input io.Writer, returns error upon any failure
func WriteFrame(target io.Writer, reader io.Reader, length uint64) error {
// write header
header := DonutFrameHeader{