Base100

https://pkg.go.dev/github.com/mroth/base100-go
Admin
Base100 is a Go implementation that encodes binary data using unique emoji symbols, representing...
Tokens:1,558
Snippets:18
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Encode Example Output

Source: https://pkg.go.dev/github.com/mroth/base100-go

Example output for the Encode function.

```text
Output:
👫👟👜🐗👨👬👠👚👢🐗👙👩👦👮👥🐗👝👦👯🐗👡👬👤👧👜👛🐗👦👭👜👩🐗👫👟👜🐗👣👘👱👰🐗👛👦👞🐁
```

--------------------------------

### Decode Example Output

Source: https://pkg.go.dev/github.com/mroth/base100-go

Example output for the Decode function.

```text
Output:
the quick brown fox jumped over the lazy dog
```

--------------------------------

### CLI Usage Help

Source: https://pkg.go.dev/github.com/mroth/base100-go

Displays the command-line interface usage and available flags for the base100 tool.

```text
base💯 (Go)
Encodes things into emoji

USAGE:
    base100 [FLAGS]

FLAGS:
    -d, --decode     Decodes input
    -i, --input      Input file (default use STDIN)
    -o, --output     Output file (default use STDOUT)
    -h, --help       Prints help information
```

--------------------------------

### Performance Benchmarks

Source: https://pkg.go.dev/github.com/mroth/base100-go

Single-cpu performance benchmarks for encoding and decoding operations.

```bash
$ go test -bench=. -cpu=1
goos: darwin
goarch: arm64
pkg: github.com/mroth/base100-go
cpu: Apple M2 Pro
BenchmarkEncode                 24076875                49.24 ns/op      913.81 MB/s
BenchmarkEncodeToString         12909928                90.94 ns/op      494.83 MB/s
BenchmarkDecode                 31709400                37.85 ns/op     1189.02 MB/s
BenchmarkDecodeString           25889036                45.45 ns/op      990.11 MB/s
BenchmarkEncoder                   18339             65083 ns/op        1006.96 MB/s
BenchmarkDecoder                   21528             56465 ns/op        1160.65 MB/s
```

--------------------------------

### Base100 Command Line Tool Usage

Source: https://pkg.go.dev/github.com/mroth/base100-go

Information on how to use the base100 command-line interface for encoding and decoding data.

```APIDOC
## Command Line Tool

### Description
A CLI tool is also provided for convenience, and ease of cross-compilation for multiple operating systems.

### Usage
```
base100 (Go)
Encodes things into emoji

USAGE:
    base100 [FLAGS]

FLAGS:
    -d, --decode     Decodes input
    -i, --input      Input file (default use STDIN)
    -o, --output     Output file (default use STDOUT)
    -h, --help       Prints help information

```

### Behavior
`base100` will read from stdin unless a file is specified, will write UTF-8 to stdout, and has a similar API to GNU's base64. Data is encoded by default, unless `--decode` is specified.
```

--------------------------------

### DecodeString Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Returns the bytes represented by the base100 string s.

```go
func DecodeString(s string) ([]byte, error)
```

--------------------------------

### Decode Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Decodes src using base100, writing to dst.

```go
func Decode(dst, src []byte) (n int, err error)
```

--------------------------------

### Base100 Encoding and Decoding Functions

Source: https://pkg.go.dev/github.com/mroth/base100-go

This section covers the core functions for encoding and decoding data using the base100 package. It includes functions for direct byte slice operations, string conversions, and calculating encoded/decoded lengths.

```APIDOC
## func Decode

### Description
Decode decodes src using base100. It writes at most DecodedLen(len(src)) bytes to dst and returns the number of bytes written. New line characters (\r and \n) should be stripped beforehand.

### Signature
```go
func Decode(dst, src []byte) (n int, err error)
```

### Example
```go
// Example usage for Decode
```

## func DecodeString

### Description
DecodeString returns the bytes represented by the base100 string s.

### Signature
```go
func DecodeString(s string) ([]byte, error)
```

### Example
```go
// Example usage for DecodeString
```

## func DecodedLen

### Description
DecodedLen returns the maximum length in bytes of the decoded data corresponding to n bytes of base100-encoded data.

### Signature
```go
func DecodedLen(n int) int
```

## func Encode

### Description
Encode encodes src to its base100 encoding, writing EncodedLen(len(src)) bytes to dst.

### Signature
```go
func Encode(dst, src []byte)
```

### Example
```go
// Example usage for Encode
```

## func EncodeToString

### Description
EncodeToString returns the base100 encoding of src.

### Signature
```go
func EncodeToString(src []byte) string
```

### Example
```go
// Example usage for EncodeToString
```

## func EncodedLen

### Description
EncodedLen returns the length in bytes of the base100 encoding of an input buffer of length n.

### Signature
```go
func EncodedLen(n int) int
```
```

--------------------------------

### EncodeToString Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Returns the base100 encoding of src.

```go
func EncodeToString(src []byte) string
```

--------------------------------

### NewDecoder Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Constructs a new base100 stream decoder.

```go
func NewDecoder(r io.Reader) io.Reader
```

--------------------------------

### Base100 Stream Encoder and Decoder

Source: https://pkg.go.dev/github.com/mroth/base100-go

This section details the functions for creating stream encoders and decoders, allowing for efficient processing of large amounts of data.

```APIDOC
## func NewDecoder

### Description
NewDecoder constructs a new base100 stream decoder.

### Signature
```go
func NewDecoder(r io.Reader) io.Reader
```

## func NewEncoder

### Description
NewEncoder returns a new base100 stream encoder. Data written to the returned writer will be encoded using base100 and then written to w.

### Signature
```go
func NewEncoder(w io.Writer) io.Writer
```
```

--------------------------------

### NewEncoder Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Returns a new base100 stream encoder.

```go
func NewEncoder(w io.Writer) io.Writer
```

--------------------------------

### Encode Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Encodes src to its base100 encoding, writing to dst.

```go
func Encode(dst, src []byte)
```

--------------------------------

### EncodedLen Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Returns the length in bytes of the base100 encoding of an input buffer.

```go
func EncodedLen(n int) int
```

--------------------------------

### DecodedLen Function Signature

Source: https://pkg.go.dev/github.com/mroth/base100-go

Returns the maximum length in bytes of the decoded data.

```go
func DecodedLen(n int) int
```
Tokens:
Raw