blobs

Documentation

Overview

blobs provides a thin layer around crypto/sha512, adding value semantics and origin data's size to hashes. blobs is intended for trusted environments as checksums or data pointers.

Index

• Variables
• func Verify(blob BLOB, r io.Reader) io.Reader
• type BLOB
  • func Make(sha512hash []byte, size int64) BLOB
  • func Parse(raw string) (BLOB, error)
  • func SlurpBytes(data []byte) BLOB
  • func SlurpFile(name string) (BLOB, error)
  • func SlurpString(data string) BLOB
  • func (blob BLOB) Equal(other BLOB) bool
  • func (blob BLOB) IsZero() bool
  • func (blob BLOB) MarshalText() ([]byte, error)
  • func (blob BLOB) Path() string
  • func (blob BLOB) Short() string
  • func (blob BLOB) Size() int64
  • func (blob BLOB) String() string
  • func (blob *BLOB) UnmarshalText(text []byte) error
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) BLOB() BLOB
  • func (r *Reader) Read(p []byte) (int, error)
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) BLOB() BLOB
  • func (w *Writer) Write(p []byte) (int, error)

Variables

var ErrNoBLOB = errors.New("no BLOB")

var ErrVerificationFailure = errors.New("verification failure")

Functions

func Verify

func Verify(blob BLOB, r io.Reader) io.Reader

Types

type BLOB

type BLOB struct {
	// contains filtered or unexported fields
}

BLOB is an opaque data reference

func Make

func Make(sha512hash []byte, size int64) BLOB

func Parse

func Parse(raw string) (BLOB, error)

func SlurpBytes

func SlurpBytes(data []byte) BLOB

func SlurpFile

func SlurpFile(name string) (BLOB, error)

func SlurpString

func SlurpString(data string) BLOB

func (BLOB) Equal

func (blob BLOB) Equal(other BLOB) bool

func (BLOB) IsZero

func (blob BLOB) IsZero() bool

func (BLOB) MarshalText

func (blob BLOB) MarshalText() ([]byte, error)

func (BLOB) Path

func (blob BLOB) Path() string

Path injectively returns a relative path where a BLOB's associated file may be stored on a filesystem. NOTE: Different to e.g. git, this path's base is the complete hash. This is done deliberately so that the BLOB's associated file fully represents the BLOB even if it is viewed without the context of a surrounding directory structure.

func (BLOB) Short

func (blob BLOB) Short() string

Short returns the first seven hexits of a BLOB's string representation, often enough to uniquely identify it. In scenarios with large amounts of data, uniqueness should be ascertained.

func (BLOB) Size

func (blob BLOB) Size() int64

func (BLOB) String

func (blob BLOB) String() string

func (*BLOB) UnmarshalText

func (blob *BLOB) UnmarshalText(text []byte) error

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

func NewReader

func NewReader(r io.Reader) *Reader

func (*Reader) BLOB

func (r *Reader) BLOB() BLOB

func (*Reader) Read

func (r *Reader) Read(p []byte) (int, error)

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(w io.Writer) *Writer

func (*Writer) BLOB

func (w *Writer) BLOB() BLOB

func (*Writer) Write

func (w *Writer) Write(p []byte) (int, error)