format

package

v0.4.0 Latest Latest Go to latest Published: Jun 21, 2025 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/TFMV/lockbox

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type LockboxFile
- func Create(filename string, schema *arrow.Schema, password string, createdBy string, ...) (*LockboxFile, error)
- func Open(filename string, password string, module crypto.Module) (*LockboxFile, error)
type Reader
- func (r *Reader) ReadColumns(columns []string) (arrow.Record, error)
- func (r *Reader) ReadRecord() (arrow.Record, error)
type Writer
- func (w *Writer) WriteRecord(record arrow.Record) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrCorruptedBlock = errors.New("corrupted data block")

ErrCorruptedBlock is returned when a data block fails checksum validation

Functions ¶

This section is empty.

Types ¶

type LockboxFile ¶

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

LockboxFile represents a lockbox file handle

func Create ¶

func Create(filename string, schema *arrow.Schema, password string, createdBy string, module crypto.Module) (*LockboxFile, error)

Create creates a new lockbox file

func Open ¶

func Open(filename string, password string, module crypto.Module) (*LockboxFile, error)

Open opens an existing lockbox file

func (*LockboxFile) Close ¶

func (lbf *LockboxFile) Close() error

Close closes the lockbox file

func (*LockboxFile) Metadata ¶

func (lbf *LockboxFile) Metadata() *metadata.Metadata

Metadata returns the file metadata

func (*LockboxFile) NewReader ¶

func (lbf *LockboxFile) NewReader(password string) (*Reader, error)

NewReader creates a new reader for the lockbox file

func (*LockboxFile) NewWriter ¶

func (lbf *LockboxFile) NewWriter(password string) (*Writer, error)

NewWriter creates a new writer for the lockbox file

func (*LockboxFile) Repair ¶ added in v0.3.0

func (lbf *LockboxFile) Repair() error

Repair attempts to remove corrupted blocks from metadata

func (*LockboxFile) Schema ¶

func (lbf *LockboxFile) Schema() *arrow.Schema

Schema returns the Arrow schema

func (*LockboxFile) ValidateBlocks ¶ added in v0.3.0

func (lbf *LockboxFile) ValidateBlocks() error

ValidateBlocks verifies the checksum of each data block

type Reader ¶

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

Reader handles reading encrypted Arrow data from lockbox files

func (*Reader) ReadColumns ¶ added in v0.2.0

func (r *Reader) ReadColumns(columns []string) (arrow.Record, error)

ReadColumns decrypts only the specified columns from the file

func (*Reader) ReadRecord ¶

func (r *Reader) ReadRecord() (arrow.Record, error)

ReadRecord reads and decrypts all columns from the file

type Writer ¶

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

Writer handles writing encrypted Arrow data to lockbox files

func (*Writer) WriteRecord ¶

func (w *Writer) WriteRecord(record arrow.Record) error

WriteRecord writes an encrypted Arrow record to the file

Source Files ¶

View all Source files

format.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL