Categorygithub.com/lazyengineering/faststatus
modulepackage
0.4.0
Repository: https://github.com/lazyengineering/faststatus.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
2
Files
342 SLOC

# README

Fast Status

GoDoc Go Report Card Build Status Coverage Status Stories in Ready

Simple API for sharing if a resource is free, busy, or very busy

Read more about this project:

# Packages

No description provided by the author
No description provided by the author

# Functions

IsOutOfRange returns true for an error indicating that the `Status` is out of range.
NewID generates a new version 4 UUID.
NewResource creates a new Resource with a generated ID and otherwise zero-value properties.

# Constants

a resource that is being utilized, but not to capacity.
a completely unutilized resource.
a resource that is being utilized to capacity.

# Variables

MagicBytes are the first two bytes of the portable binary representation of a Resource.

# Structs

A Resource represents any resource (a person, a bathroom, a server, etc.) that needs to communicate how busy it is.

# Type aliases

ID is a UUIDv4 compatible byte array.
Status represents how busy a given resource is on a scale from 0–2, where 0 (Free) is a completely unoccupied resource, 2 (Occupied) is completely occupied, and 1 (Busy) is anything between.