1 unstable release

0.0.1 Feb 5, 2023

#4 in #hsh

50 downloads per month
Used in 2 crates (via cjwt)

MIT/Apache

30KB
378 lines

IDK

A Rust library for managing errors and exceptions

Made With Love Crates.io Lib.rs Docs.rs License

divider

Welcome to IDK 👋

IDK Banner

Website â€ĸ Documentation â€ĸ Report Bug â€ĸ Request Feature â€ĸ Contributing Guidelines

Overview 📖

IDontKnow (IDK) is a Rust library that has functions and variables designed to make it easy for your program to report informative error messages. You can use the IDK library to create error messages that are clear, concise, and actionable.

Features ✨

The library includes multiple modules: Common, Error, Jwt, Property, Stacktrace, and Traits.

  • The common module: This module provides a foundation of common errors that can be utilized throughout the entire project. These functionalities serve as a building block for the rest of the project, making it easier for developers to create and manage their code.
  • The error module: This module contains all the error types that are used in the project. By providing a centralized location for errors, developers can quickly and easily identify and resolve any issues that may arise.
  • The jwt module: This module offers the tools necessary to encode and decode JSON Web Tokens (JWT). With a simple, easy-to-use interface, developers can ensure secure communication between parties.
  • The property module: This module provides the functionality to create and manage properties. By utilizing this module, developers can keep track of all properties within the project and make changes as necessary.
  • The stacktrace module: This module offers the tools to create and manage stacktraces. By providing detailed information about the execution of the code, developers can quickly identify and resolve any issues that may arise.
  • The traits module: This module provides functionality to create and manage traits. By utilizing this module, developers can ensure that all traits within the project are consistent and well-defined.

Installation đŸ“Ļ

It takes just a few minutes to get up and running with idk.

Requirements

idk requires Rust 1.67.0 or later.

Documentation

ℹī¸ Info: Please check out our website for more information and find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use idk in your project, add the following to your Cargo.toml file:

[dependencies]
idk = "0.0.1"

Add the following to your main.rs file:

extern crate idk;
use idk::*;

then you can use the functions in your application code.

Examples

IDK comes with a set of examples that you can use to get started. The examples are located in the examples directory of the project. To run the examples, clone the repository and run the following command in your terminal from the project root directory.

cargo run --example idk

Semantic Versioning Policy đŸšĨ

For transparency into our release cycle and in striving to maintain backward compatibility, IDK follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

Contribution 🤝

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

divider

Acknowledgements 💙

A big thank you to all the awesome contributors of Mini Functions for their help and support.

Dependencies

~6.5–9MB
~258K SLoC