Tool Chest

Provides a suite of golang tools that can be referenced and used in golang projects.

License

This Source Code Form is subject to the terms of the Apache Public License, version 2.0. If a copy of the APL was not distributed with this file, you can obtain one at https://www.apache.org/licenses/LICENSE-2.0.txt.

Tools

• Work Queue, located in toolchest/workqueue, provides a que which work can be submitted to and worked on by multiple go routines. Features include:
  • Ability to configure queue length and number of go routines operating on queue
  • Error monitoring
  • Prioritizing work submitted to queue
  • Option to name work submitted to queue for later reference
  • Stopping and breaking the queue
  • Resize queue length
  • Dequeue work in queue
  • View work in queue and it's current state, priority and position in queue.
• Publication package provides a generic publish-subscribe (pub/sub) mechanism for Go applications. It allows you to create publications to which multiple subscribers can listen. When a message is published, it's distributed to all relevant subscribers.
  • Generic: Supports publishing and subscribing to messages of any type.
  • Filtering: Subscribers can define filters to receive only messages that meet specific criteria.
  • Buffered Channels: Subscribers receive messages through buffered channels, allowing for asynchronous message handling.
  • Concurrency-Safe: Designed for concurrent use, ensuring safe message delivery in multi-threaded environments.
  • Timeout Support: Control the maximum time spent attempting to deliver a message to a subscriber.
  • Clean Shutdown: Gracefully close publications and subscriber channels.
  • Unsubscribe: Subscribers can unsubscribe from a publication.
• ValidationError
  • Facilitates error reflecting validation issues to a user.
  • Supports warnings and errors
  • Reflects validation errors over nested types (i.e. Customer has an address)
• Storage
  • SafeMap
    • A thread safe map
  • FifoMapCache
    • A thread safe map with a maximum size. When the cache is full, the oldest entries are evicted.
  • GenericStack
    • A generic stack data structure
• Propositions
  • Provides a set of proposition functions in Go. These functions allow evaluations of various conditions on various types, each function returning either true or false.
• SliceOps
  • Provides a set of utility functions for working with slices in Go. These functions include operations such as cutting, removing, inserting, filtering, pushing, popping, and more.
• Server
  • A starting point for setting up and managing HTTP and/or gRPC services.
  • Serve both HTTP and gRPC services from single server.
  • Ability to configuration via configuration builder with chaining.
• Generic package contains standard library types that are not yet type safe using generics and wraps them in types that are type safe using generics.
  • SyncMap wraps a sync.Map with a generic.
• Additional tools to come!

Contribution

Contributing to this project is welcome! There are some guidelines you should consider described in the CONTRIBUTION.md file.

Code Of Conduct

Code of conduct is described in the CODEOFCONDUCT.md file.