https://github.com/xyproto/binary

:paw_prints: Detect if a file is binary or text
https://github.com/xyproto/binary

binary go module text utility

Last synced: 15 days ago
JSON representation

:paw_prints: Detect if a file is binary or text

• Host: GitHub
• URL: https://github.com/xyproto/binary
• Owner: xyproto
• License: bsd-3-clause
• Created: 2022-04-08T09:27:29.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-25T14:31:50.000Z (about 1 year ago)
• Last Synced: 2025-01-08T13:56:23.748Z (18 days ago)
• Topics: binary, go, module, text, utility
• Language: Go
• Homepage:
• Size: 1.09 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Binary

Go module and command line utility for checking if the given file or data is likely to be **binary** or **text**.

* It does so by reading the first, middle and last 24 bytes of the file and trying to convert the data to utf8.

* If one of the 24 byte blocks can not be converted to utf8, it's considered to be a binary file.

* Also, if one of the blocks have more than 33% zero bytes, it's considered to be a binary file.

* If the file is empty, it's considered to be a text file.

* The `binary` utility has overlapping functionality with the `file` utility, but with a more limited focus.

* If the first 24 bytes indicates that it's a binary file, the deduction is done, and no more seeking or reading will happen.

## Installing the utility

With Go 1.17 or later:

    go install github.com/xyproto/binary/cmd/binary@latest

## Example use

* `binary /usr/bin/ls` returns `binary`.

* `binary /etc/fstab` returns `text`.

## Using the Go module

```go

package main

import (

    "fmt"

    "os"

    "github.com/xyproto/binary"

)

func main() {

    filename := os.Args[0]

    isBinary, err := binary.File(filename)

    if err != nil {

        fmt.Fprintf(os.Stderr, "%s\n", err)

        os.Exit(1)

    }

    fmt.Printf("%s is a binary file: %v\n", filename, isBinary)

}

```

The `binary.Data` function can be used to determine if a byte slice contains binary data or not.

## General info

* Version: 1.3.3

* License: BSD-3

* Author: Alexander F. Rødseth <[email protected]>