https://github.com/realtristan/bettercache

Modern Thread-Safe Caching System with Basic Full Text Functionalities
https://github.com/realtristan/bettercache

cache easy-to-use fast full-text-search go thread-safe

Last synced: 2 months ago
JSON representation

Modern Thread-Safe Caching System with Basic Full Text Functionalities

• Host: GitHub
• URL: https://github.com/realtristan/bettercache
• Owner: realTristan
• License: mit
• Created: 2022-08-25T20:00:46.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-20T13:56:48.000Z (over 1 year ago)
• Last Synced: 2024-06-20T06:37:55.339Z (7 months ago)
• Topics: cache, easy-to-use, fast, full-text-search, go, thread-safe
• Language: Go
• Homepage: https://realtristan.github.io/bettercache/
• Size: 195 KB
• Stars: 52
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Better Cache ![Stars](https://img.shields.io/github/stars/realTristan/bettercache?color=brightgreen) ![Watchers](https://img.shields.io/github/watchers/realTristan/bettercache?label=Watchers)

![banner (5)](https://user-images.githubusercontent.com/75189508/186757681-6b7f97e8-ec37-448a-83cc-75106ed16309.png)

# Install

`go get -u github.com/realTristan/bettercache`

# Example Usage

```go

package main

// Import Packages

import (

    "fmt"

    bc "github.com/realTristan/bettercache"

)

func main() {

    // Initialize the cache

    var c *bc.Cache = bc.Init(-1) // -1 (no size limit)

    // Add key1 to the cache

    c.Set("key1", "value1", true)

    // Get key from the cache

    var data string = c.Get("key1")

    fmt.Println(data)

    // Full Text Search for the key's contents

    var res []string = c.FullTextSearch(&bc.TextSearch{

        Limit:      -1,                 // No limit

        Query:      []byte("value"),    // Search for "value"

        StrictMode: false,              // Ignore CAPS

    })

    fmt.Println(res)

    // Remove key1 from the cache

    var removedKey string = c.Remove("key1")

    fmt.Println(removedKey)

}

```

# License

MIT License

Copyright (c) 2022 Tristan Simpson

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.