formats

README

About

formats is a command line file explorer / hex viewer, written in Golang.

Demo: https://asciinema.org/a/7uce44hzwvpi5dijxh0jpcc7g

Installation

go get -u github.com/martinlindhe/formats/cmd/formats

Keyboard navigation

• Left/Right arrow keys to navigate between top-level fields (turquoise)
• Enter to select current top-level field
• Left/Right arrow keys to navigate between sub-level fields (yellow)
• Escape to leave sub-level navigation
• Q to quit the program

Supported formats

Please see the status matrix.

License

Under MIT

Documentation

Index

• func ParseLayout(file *os.File) (*parse.ParsedLayout, error)
• type MatchingParsers
  • func MatchAll(file *os.File) (MatchingParsers, error)
  • func (mp *MatchingParsers) ChoseOne(file *os.File) (*parse.ParsedLayout, error)
  • func (mp *MatchingParsers) First() *parse.ParsedLayout
• type Parser

Functions

func ParseLayout

func ParseLayout(file *os.File) (*parse.ParsedLayout, error)

ParseLayout returns a ParsedLayout for the file

Types

type MatchingParsers

type MatchingParsers []parse.ParsedLayout

MatchingParsers is a list parsed layouts with different Parser

func MatchAll

func MatchAll(file *os.File) (MatchingParsers, error)

MatchAll returns all matching parsers

func (*MatchingParsers) ChoseOne

func (mp *MatchingParsers) ChoseOne(file *os.File) (*parse.ParsedLayout, error)

ChoseOne asks the user to select one of the matching parsers

func (*MatchingParsers) First

func (mp *MatchingParsers) First() *parse.ParsedLayout

First returns the first matching Parser

type Parser

type Parser func(*parse.Checker) (*parse.ParsedLayout, error)

Parser is a specialized parser for a file format