Skip to content

Commit

Permalink
docs(swiftide): documented file swiftide/src/integrations/redis/mod.rs (
Browse files Browse the repository at this point in the history
#23)

Co-authored-by: bosun-ai[bot] <157630444+bosun-ai[bot]@users.noreply.github.com>
  • Loading branch information
bosun-ai[bot] authored Jun 13, 2024
1 parent 7229af8 commit 6240a26
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions swiftide/src/integrations/redis/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
//! This module provides the integration with Redis for caching nodes in the Swiftide system.
//!
//! The primary component of this module is the `RedisNodeCache`, which is re-exported for use
//! in other parts of the system. The `RedisNodeCache` struct is responsible for managing and
//! caching nodes during the ingestion process, leveraging Redis for efficient storage and retrieval.
//!
//! # Overview
//!
//! The `RedisNodeCache` struct provides methods for:
//! - Connecting to a Redis database
//! - Checking if a node is cached
//! - Setting a node in the cache
//! - Resetting the cache (primarily for testing purposes)
//!
//! This integration is essential for ensuring efficient node management and caching in the Swiftide system.
mod node_cache;

pub use node_cache::RedisNodeCache;

0 comments on commit 6240a26

Please sign in to comment.