bytes2string

README

bytes2string

Summary

Go module for converting int64 byte counts to a shortened SI, or IEC, string format. For example, 1000000 to '1.0 MB' or 1048576 to '1.0 MiB'.

Installation

go get github.com/jimrazmus/bytes2string

Usage

First, import the module.

import github.com/jimrazmus/bytes2string

Then, use the provided functions.

log.Println(ByteCountSI(12345678))

log.Println(ByteCountIEC(12345678))

Contributing

Please follow the Conventional Commits specification for your commit messages. Commit type options include: feat, fix, build, chore, ci, docs, style, refactor, perf, and test.

Open a pull request when you have completed your work and want it reviewed for inclusion.

Author

Functions originate here: https://yourbasic.org/golang/formatting-byte-size-to-human-readable-format/

Jim Razmus II - Minor modifications and formatting, along with adding testing and packaging.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

Documentation

Overview

Package bytes2string provides functions for converting int64 byte counts to a shortened SI, or IEC, string format.

Index

• func ByteCountIEC(bytes int64) string
• func ByteCountSI(bytes int64) string

Functions

func ByteCountIEC

func ByteCountIEC(bytes int64) string

ByteCountIEC returns a formatted string using the appropriate International Electrotechnical Commission prefix for any positive byte count or an empty string otherwise.

func ByteCountSI

func ByteCountSI(bytes int64) string

ByteCountSI returns a formatted string using the appropriate International System of Units prefix for any positive byte count or an empty string otherwise.