filebuf

README

https://pkg.go.dev/github.com/HalCanary/facility/filebuf

Documentation

Overview

Copyright 2022 Hal Canary Use of this program is governed by the file LICENSE.

Index

• type FileBuf
  • func (b FileBuf) Changed() bool
  • func (b *FileBuf) Close() error
  • func (b *FileBuf) Len() int
  • func (b *FileBuf) Reset() error
  • func (b *FileBuf) Write(p []byte) (int, error)
  • func (b *FileBuf) WriteString(s string) (int, error)

Types

type FileBuf

type FileBuf struct {
	Path string
	// contains filtered or unexported fields
}

Implements `io.Writer`, `io.StringWriter`, `io.WriteCloser`. When `Close()` is called, writes buffer to `Path`, if it differs from the contents of the file at `Path` or there is no file at `Path`. `Path` must be populated by the caller.

func (FileBuf) Changed

func (b FileBuf) Changed() bool

After `Close` is called, this will return `true` if the file changed.

func (*FileBuf) Close

func (b *FileBuf) Close() error

Close writes buffer to `Path`, if it differs from the contents of the file at `Path` or there is no file at `Path`.

func (*FileBuf) Len

func (b *FileBuf) Len() int

Len returns the number of bytes in the buffer.

func (*FileBuf) Reset

func (b *FileBuf) Reset() error

Reset returns the internal buffer to empty.

func (*FileBuf) Write

func (b *FileBuf) Write(p []byte) (int, error)

Write implements the standard Write interface

func (*FileBuf) WriteString

func (b *FileBuf) WriteString(s string) (int, error)

WriteString writes the contents of s.