packs

Documentation

Index

• type CachedReader
  • func NewCachedReader(log *slog.Logger, cache lru.Cache[*Pack]) *CachedReader
  • func (r *CachedReader) Read(ctx context.Context, repo repos.Repo, packId string) (*Pack, error)
• type Chunk
  • func (c *Chunk) Key() string
  • func (c *Chunk) Kind() string
  • func (c *Chunk) Length() int
  • func (c *Chunk) Link(pack string, chunk *Chunk)
  • func (c *Chunk) Links() []*Ref
  • func (c *Chunk) Print(w io.StringWriter)
  • func (c *Chunk) String() string
• type Pack
  • func New() *Pack
  • func Read(ctx context.Context, repo repos.Repo, packId string) (*Pack, error)
  • func Unpack(data []byte) (*Pack, error)
  • func (p *Pack) Add(chunks ...*Chunk)
  • func (p *Pack) Chunk(key string) (*Chunk, bool)
  • func (p *Pack) Chunks() []*Chunk
  • func (p *Pack) Encode(w io.Writer) error
  • func (p *Pack) Length() int
  • func (p *Pack) Pack() ([]byte, error)
  • func (p *Pack) Print(w io.StringWriter)
  • func (p *Pack) String() string
• type Reader
• type Ref

Types

type CachedReader

type CachedReader struct {
	Limiter rate.Limiter
	// contains filtered or unexported fields
}

func NewCachedReader

func NewCachedReader(log *slog.Logger, cache lru.Cache[*Pack]) *CachedReader

NewCachedReader creates a new cached reader

func (*CachedReader) Read

func (r *CachedReader) Read(ctx context.Context, repo repos.Repo, packId string) (*Pack, error)

type Chunk

type Chunk struct {
	Path    string      `json:"path,omitempty"`
	Mode    fs.FileMode `json:"mode,omitempty"`
	Size    int64       `json:"size,omitempty"`
	Hash    string      `json:"hash,omitempty"`
	ModTime int64       `json:"modtime,omitempty"`
	// Data can be set if the file is small enough to fit in one chunk. Otherwise
	// it will be nil and the file will be chunked with links to the blobs
	Data []byte `json:"data,omitempty"`
	Refs []*Ref `json:"refs,omitempty"`
}

Chunk can either be file metadata or a blob. If the file is small enough to fit in one chunk, it can be a file with data.

func (*Chunk) Key

func (c *Chunk) Key() string

func (*Chunk) Kind

func (c *Chunk) Kind() string

func (*Chunk) Length

func (c *Chunk) Length() int

func (*Chunk) Link

func (c *Chunk) Link(pack string, chunk *Chunk)

func (*Chunk) Links

func (c *Chunk) Links() []*Ref

func (*Chunk) Print

func (c *Chunk) Print(w io.StringWriter)

func (*Chunk) String

func (c *Chunk) String() string

type Pack

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

func New

func New() *Pack

func Read

func Read(ctx context.Context, repo repos.Repo, packId string) (*Pack, error)

func Unpack

func Unpack(data []byte) (*Pack, error)

Unpack reads a pack from a byte slice

func (*Pack) Add

func (p *Pack) Add(chunks ...*Chunk)

func (*Pack) Chunk

func (p *Pack) Chunk(key string) (*Chunk, bool)

func (*Pack) Chunks

func (p *Pack) Chunks() []*Chunk

func (*Pack) Encode

func (p *Pack) Encode(w io.Writer) error

func (*Pack) Length

func (p *Pack) Length() int

Length returns the number of bytes in the pack

func (*Pack) Pack

func (p *Pack) Pack() ([]byte, error)

func (*Pack) Print

func (p *Pack) Print(w io.StringWriter)

func (*Pack) String

func (p *Pack) String() string

type Reader

type Reader interface {
	Read(ctx context.Context, repo repos.Repo, packId string) (*Pack, error)
}

type Ref

type Ref struct {
	Pack string
	Hash string
}

Ref is a reference to another blob chunk