sleepycat

README

sleepycat

sleepycat is a Go package for reading user input from the terminal.

The package provides typed input functions and a consistent option-based API for prompts, validation, and retry behavior.

Installation

go get github.com/Rajdeep-Nemo/sleepycat

Example

package main

import (
	"fmt"
	"os"

	"github.com/Rajdeep-Nemo/sleepycat"
)

func main() {
	age, err := sleepycat.Int(
		sleepycat.Prompt("Enter age: "),
		sleepycat.MaxAttempt(3),
	)
	if err != nil {
		fmt.Println(err)
		os.Exit(0)
	}

	fmt.Println(age)
}

Available

Input

• Int()
• Float32()
• Float64()
• Bool()
• String()
• Byte()
• Rune()
• Int8()
• Int16()
• Int32()
• Int64()
• Uint()
• Uint8()
• Uint16()
• Uint32()
• Uint64()

Options

• Prompt()
• MaxAttempt()

Project Structure

sleepycat/
├── .github/
│   └── workflows/
│       └── ci.yml              # Continuous integration
│
├── examples/                   # Example programs
│   ├── int/
│   │   └── main.go             
│   └── ...                     # More Examples
│
├── internal/
│   └── input.go                # Terminal input helpers
│
├── config.go                   # Config and functional options
├── parser.go                   # Shared parsing/retry logic
├── int.go                      # Integer input
├── float32.go                  # 32 bit float input
├── float64.go                  # 64 bit float input
├── ...                         # Other inputs
│
├── helpers_test.go             # Shared helper functions
├── int_test.go
├── float32_test.go
├── float64_test.go
├── ...                         # Other test cases
│
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
└── README.md

Documentation

Index

• func Bool(opts ...option) (bool, error)
• func Byte(opts ...option) (byte, error)
• func Float32(opts ...option) (float32, error)
• func Float64(opts ...option) (float64, error)
• func Int(opts ...option) (int, error)
• func Int8(opts ...option) (int8, error)
• func Int16(opts ...option) (int16, error)
• func Int32(opts ...option) (int32, error)
• func Int64(opts ...option) (int64, error)
• func MaxAttempt(count int) option
• func Prompt(inputPrompt string) option
• func Rune(opts ...option) (rune, error)
• func String(opts ...option) (string, error)
• func Uint(opts ...option) (uint, error)
• func Uint8(opts ...option) (uint8, error)
• func Uint16(opts ...option) (uint16, error)
• func Uint32(opts ...option) (uint32, error)
• func Uint64(opts ...option) (uint64, error)

Functions

func Bool

func Bool(opts ...option) (bool, error)

Bool reads a boolean value from the input source.

func Byte

func Byte(opts ...option) (byte, error)

Byte reads a single ASCII character from the input source and returns it as a byte.

func Float32

func Float32(opts ...option) (float32, error)

Float32 reads a floating-point number from the input source and returns it as a float32.

func Float64

func Float64(opts ...option) (float64, error)

Float64 reads a floating-point number from the input source and returns it as a float64.

func Int

func Int(opts ...option) (int, error)

Int reads an integer from the input source and returns it as an int.

func Int8

func Int8(opts ...option) (int8, error)

Int8 reads an integer from the input source and returns it as an int8.

func Int16

func Int16(opts ...option) (int16, error)

Int16 reads an integer from the input source and returns it as an int16.

func Int32

func Int32(opts ...option) (int32, error)

Int32 reads an integer from the input source and returns it as an int32.

func Int64

func Int64(opts ...option) (int64, error)

Int64 reads an integer from the input source and returns it as an int64.

func MaxAttempt

func MaxAttempt(count int) option

MaxAttempt limits the number of input attempts. A value of 0 allows unlimited attempts.

func Prompt

func Prompt(inputPrompt string) option

Prompt sets the text displayed before reading input.

func Rune

func Rune(opts ...option) (rune, error)

Rune reads a Unicode code point from the input source.

func String

func String(opts ...option) (string, error)

String reads a string from the input source. MaxAttempt does not affect String because every input is valid.

func Uint

func Uint(opts ...option) (uint, error)

Uint reads an unsigned integer from the input source and returns it as a uint.

func Uint8

func Uint8(opts ...option) (uint8, error)

Uint8 reads an unsigned integer from the input source and returns it as a uint8.

func Uint16

func Uint16(opts ...option) (uint16, error)

Uint16 reads an unsigned integer from the input source and returns it as a uint16.

func Uint32

func Uint32(opts ...option) (uint32, error)

Uint32 reads an unsigned integer from the input source and returns it as a uint32.

func Uint64

func Uint64(opts ...option) (uint64, error)

Uint64 reads an unsigned integer from the input source and returns it as a uint64.