probe

Documentation

Overview

Package probe defines common probe interfaces.

Index

• type MagicMatch
• type Partition
• type Prober
• type Reader
• type Result

Types

type MagicMatch

type MagicMatch struct {
	Prober Prober
	Magic  magic.Magic
}

MagicMatch is a magic detection result.

type Partition

type Partition struct {
	UUID     *uuid.UUID
	TypeUUID *uuid.UUID
	Label    *string

	Index uint // 1-based index

	Offset uint64
	Size   uint64
}

Partition is a probe sub-result.

type Prober

type Prober interface {
	// Name returns the name of the filesystem or volume manager.
	Name() string
	// Magic returns the magic value for the filesystem or volume manager.
	Magic() []*magic.Magic
	// Probe runs the further inspection and returns the result if successful.
	Probe(Reader, magic.Magic) (*Result, error)
}

Prober is an interface for probing filesystems and volume managers.

type Reader

type Reader interface {
	io.ReaderAt

	GetSectorSize() uint
	GetSize() uint64
}

Reader is a context for probing filesystems and volume managers.

type Result

type Result struct {
	UUID  *uuid.UUID
	Label *string

	Parts []Partition

	BlockSize           uint32
	FilesystemBlockSize uint32
	ProbedSize          uint64
}

Result is a probe result.