Struct Redis

pub struct Redis { /* private fields */ }

Available on crate feature redis only.

Redis provides a caching mechanism for nodes using Redis. It helps in optimizing the indexing process by skipping nodes that have already been processed.

Fields

• client - The Redis client used to interact with the Redis server.
• connection_manager - Manages the Redis connections asynchronously.
• key_prefix - A prefix used for keys stored in Redis to avoid collisions.

Implementations

impl Redis

pub fn try_from_url( url: impl AsRef<str>, prefix: impl AsRef<str>, ) -> Result<Self>

Creates a new Redis instance from a given Redis URL and key prefix.

Parameters

• url - The URL of the Redis server.
• prefix - The prefix to be used for keys stored in Redis.

Returns

A Result containing the Redis instance or an error if the client could not be created.

Errors

Returns an error if the Redis client cannot be opened.

pub fn try_build_from_url(url: impl AsRef<str>) -> Result<RedisBuilder>

Errors

Returns an error if the Redis client cannot be opened

pub fn builder() -> RedisBuilder

Builds a new Redis instance from the builder.

Trait Implementations

impl Clone for Redis

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Redis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl NodeCache for Redis

fn get<'life0, 'life1, 'async_trait>( &'life0 self, node: &'life1 Node, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Checks if a node is present in the cache.

Parameters

• node - The node to be checked in the cache.

Returns

true if the node is present in the cache, false otherwise.

Errors

Logs an error and returns false if the cache check fails.

fn set<'life0, 'life1, 'async_trait>( &'life0 self, node: &'life1 Node, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sets a node in the cache.

Parameters

• node - The node to be set in the cache.

Errors

Logs an error if the node cannot be set in the cache.

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Optionally provide a method to clear the cache

fn name(&self) -> &'static str

impl Persist for Redis

fn store<'life0, 'async_trait>( &'life0 self, node: Node, ) -> Pin<Box<dyn Future<Output = Result<Node>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stores a node in Redis using the SET command.

By default nodes are stored with the path and hash as key and the node serialized as JSON as value.

You can customize the key and value used for storing nodes by setting the persist_key_fn and persist_value_fn fields.

fn batch_store<'life0, 'async_trait>( &'life0 self, nodes: Vec<Node>, ) -> Pin<Box<dyn Future<Output = IndexingStream> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stores a batch of nodes in Redis using the MSET command.

By default nodes are stored with the path and hash as key and the node serialized as JSON as value.

You can customize the key and value used for storing nodes by setting the persist_key_fn and persist_value_fn fields.

fn setup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn batch_size(&self) -> Option<usize>

fn name(&self) -> &'static str