serr
/
candycache
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme md

main
serr 2025-01-06 01:24:59 +03:00
parent 09941f7723
commit fca8b3d9ff
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,20 +2,20 @@
**CandyCache** — это простой и эффективный кэш на языке Go, который позволяет хранить данные с ограниченным временем жизни (TTL). **CandyCache** — это простой и эффективный кэш на языке Go, который позволяет хранить данные с ограниченным временем жизни (TTL).
## Установка # Установка
Для использования CandyCache в вашем проекте, установите его, используя **go get git.hikan.ru/serr/candycache**, далее просто добавьте в блок импорта. Для использования CandyCache в вашем проекте, установите его, используя **go get git.hikan.ru/serr/candycache**, далее просто добавьте в блок импорта.
## Основные возможности # Основные возможности
- **Автоматика**: автоматическая очистка устаревших элементов и возможность ее отключения - **Автоматика**: автоматическая очистка устаревших элементов и возможность ее отключения
- **Возможность ручного управления** - **Возможность ручного управления**
- **Безопасность**: конкурентный доступ к данным возможен благодаря мьютексам - **Безопасность**: конкурентный доступ к данным возможен благодаря мьютексам
- **Гибкость**: кэш может хранить любые типы данных - **Гибкость**: кэш может хранить любые типы данных
## Использование # Использование
### Создание кэша ## Создание кэша
Для создания нового экземпляра кэша используйте функцию **Cacher**, передавая интервал очистки в наносекундах. Для создания нового экземпляра кэша используйте функцию **Cacher**, передавая интервал очистки в наносекундах.
@ -30,7 +30,7 @@ cache := candycache.Cacher(10 * time.Minute) // Очистка каждые 10
cache := candycache.Cacher(-1) // Кэш не будет очищаться автоматически cache := candycache.Cacher(-1) // Кэш не будет очищаться автоматически
``` ```
### Добавление элемента ## Добавление элемента
Для добавления элемента в кэш используйте метод **Add**: Для добавления элемента в кэш используйте метод **Add**:
```go ```go
@ -38,7 +38,7 @@ cache.Add("key", "value", 5 * time.Minute) // Элемент будет счит
``` ```
В случае, если по указанном ключу уже что-то хранится, оно будет заменено на новый элемент. В случае, если по указанном ключу уже что-то хранится, оно будет заменено на новый элемент.
### Получение элемента ## Получение элемента
Для получения элемента из кэша используйте метод **Get**: Для получения элемента из кэша используйте метод **Get**: