Struct RefreshTrigger 

pub struct RefreshTrigger { /* private fields */ }

A trigger that can be cloned and triggered multiple times Similar to oneshot but reusable

Implementations

impl RefreshTrigger

pub fn new() -> Self

pub fn trigger(&self)

Trigger a full cache refresh (clears all entries)

Examples found in repository

examples/library_usage.rs (line 40)

async fn main() {
    // Initialize tracing (optional but recommended)
    // tracing_subscriber::fmt::init();

    // Create proxy configuration
    // You can specify method prefixes to filter by HTTP method
    let proxy_config = CreateProxyConfig::new("http://localhost:8080".to_string())
        .with_include_paths(vec![
            "/api/*".to_string(),
            "/public/*".to_string(),
            "GET /admin/stats".to_string(), // Only cache GET requests to this endpoint
        ])
        .with_exclude_paths(vec![
            "/api/admin/*".to_string(),
            "POST *".to_string(),   // Don't cache any POST requests
            "PUT *".to_string(),    // Don't cache any PUT requests
            "DELETE *".to_string(), // Don't cache any DELETE requests
        ])
        .caching_strategy(CacheStrategy::None)
        .compression_strategy(CompressStrategy::Brotli)
        .with_websocket_enabled(true); // Enable WebSocket support (default: true)

    // Create proxy - proxy_url is the backend server to proxy requests to
    let (proxy_app, refresh_trigger): (Router, RefreshTrigger) = create_proxy(proxy_config);

    // You can clone and use the refresh_trigger in your code
    let trigger_clone = refresh_trigger.clone();

    // Example: Trigger cache refresh from another part of your application
    tokio::spawn(async move {
        tokio::time::sleep(tokio::time::Duration::from_secs(60)).await;

        // Clear all cache entries
        trigger_clone.trigger();
        println!("All cache cleared!");

        tokio::time::sleep(tokio::time::Duration::from_secs(30)).await;

        // Clear only cache entries matching a pattern (supports wildcards)
        trigger_clone.trigger_by_key_match("GET:/api/*");
        println!("Cache cleared for GET:/api/* pattern!");
    });

    // Start the proxy server
    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();

    println!("Proxy server listening on http://0.0.0.0:3000");
    println!("Caching paths: /api/*, /public/*, GET /admin/stats");
    println!("Excluding: /api/admin/*, POST *, PUT *, DELETE *");
    println!("Cache strategy: none (proxy-only mode)");
    println!("Compression strategy: brotli (applies only to cached responses)");
    println!("Note: Cache reads and writes are disabled in this example");
    println!("WebSocket support: enabled");

    axum::serve(listener, proxy_app).await.unwrap();
}

pub fn trigger_by_key_match(&self, pattern: &str)

Trigger a cache refresh for entries matching a pattern Supports wildcards: “/api/”, “GET:/api/”, etc.

Examples found in repository

examples/library_usage.rs (line 46)

async fn main() {
    // Initialize tracing (optional but recommended)
    // tracing_subscriber::fmt::init();

    // Create proxy configuration
    // You can specify method prefixes to filter by HTTP method
    let proxy_config = CreateProxyConfig::new("http://localhost:8080".to_string())
        .with_include_paths(vec![
            "/api/*".to_string(),
            "/public/*".to_string(),
            "GET /admin/stats".to_string(), // Only cache GET requests to this endpoint
        ])
        .with_exclude_paths(vec![
            "/api/admin/*".to_string(),
            "POST *".to_string(),   // Don't cache any POST requests
            "PUT *".to_string(),    // Don't cache any PUT requests
            "DELETE *".to_string(), // Don't cache any DELETE requests
        ])
        .caching_strategy(CacheStrategy::None)
        .compression_strategy(CompressStrategy::Brotli)
        .with_websocket_enabled(true); // Enable WebSocket support (default: true)

    // Create proxy - proxy_url is the backend server to proxy requests to
    let (proxy_app, refresh_trigger): (Router, RefreshTrigger) = create_proxy(proxy_config);

    // You can clone and use the refresh_trigger in your code
    let trigger_clone = refresh_trigger.clone();

    // Example: Trigger cache refresh from another part of your application
    tokio::spawn(async move {
        tokio::time::sleep(tokio::time::Duration::from_secs(60)).await;

        // Clear all cache entries
        trigger_clone.trigger();
        println!("All cache cleared!");

        tokio::time::sleep(tokio::time::Duration::from_secs(30)).await;

        // Clear only cache entries matching a pattern (supports wildcards)
        trigger_clone.trigger_by_key_match("GET:/api/*");
        println!("Cache cleared for GET:/api/* pattern!");
    });

    // Start the proxy server
    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();

    println!("Proxy server listening on http://0.0.0.0:3000");
    println!("Caching paths: /api/*, /public/*, GET /admin/stats");
    println!("Excluding: /api/admin/*, POST *, PUT *, DELETE *");
    println!("Cache strategy: none (proxy-only mode)");
    println!("Compression strategy: brotli (applies only to cached responses)");
    println!("Note: Cache reads and writes are disabled in this example");
    println!("WebSocket support: enabled");

    axum::serve(listener, proxy_app).await.unwrap();
}

pub fn subscribe(&self) -> Receiver<RefreshMessage>

Subscribe to refresh events

Trait Implementations

impl Clone for RefreshTrigger

fn clone(&self) -> RefreshTrigger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RefreshTrigger

fn default() -> Self

Returns the “default value” for a type.