file

Documentation

Overview

Package file allows reading/writing from/to a Rump file. Rump file protocol is key✝✝value✝✝ttl✝✝key✝✝value✝✝ttl✝✝...

Index

• type File
  • func New(path string, bus message.Bus, silent, ttl bool) *File
  • func (f *File) Read(ctx context.Context) error
  • func (f *File) Write(ctx context.Context) error

Types

type File

type File struct {
	Path   string
	Bus    message.Bus
	Silent bool
	TTL    bool
}

File can read and write, to a file Path, using the message Bus.

func New

func New(path string, bus message.Bus, silent, ttl bool) *File

New creates the File struct, to be used for reading/writing.

func (*File) Read

func (f *File) Read(ctx context.Context) error

Read scans a Rump file and sends Payloads to the message bus.

func (*File) Write

func (f *File) Write(ctx context.Context) error

Write writes to a Rump file Payloads from the message bus.