sword-layers 0.3.0

Tower layers for the Sword web framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Response compression middleware.
//!
//! This module defines compression configuration and conversion into
//! `tower_http::compression::CompressionLayer` using the configured algorithms.

use crate::{DisplayConfig, SwordLayerRegistrar};

use serde::{Deserialize, Serialize};
use std::any::Any;
use thisconfig::Config;
use thisconfig::ConfigItem;

pub use tower_http::compression::CompressionLayer;

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(default)]
pub struct CompressionConfig {
    /// Whether to display the configuration details.
    pub display: bool,
    /// A list of strings representing the compression algorithms to use
    /// (e.g., "gzip", "deflate", "br", "zstd
    pub algorithms: Vec<String>,
}

impl Default for CompressionConfig {
    fn default() -> Self {
        Self {
            display: false,
            algorithms: vec!["gzip".into(), "br".into()],
        }
    }
}

impl From<CompressionConfig> for CompressionLayer {
    fn from(config: CompressionConfig) -> Self {
        let mut layer = CompressionLayer::new();

        for algorithm in &config.algorithms {
            match algorithm.to_lowercase().as_str() {
                "gzip" => layer = layer.gzip(true),
                "deflate" => layer = layer.deflate(true),
                "br" | "brotli" => layer = layer.br(true),
                "zstd" => layer = layer.zstd(true),
                _ => {}
            }
        }

        layer
    }
}

impl DisplayConfig for CompressionConfig {
    fn display(&self) {
        if self.display {
            tracing::debug!(
                target: "sword.layers.compression",
                algorithms = ?self.algorithms,
                "Compression Layer configuration"
            );
        }
    }
}

impl ConfigItem for CompressionConfig {
    fn key() -> &'static str {
        "compression"
    }
}

inventory::submit! {
    SwordLayerRegistrar {
        name: "compression",
        register: |config: &Config| {
            let layer: CompressionLayer = config.get_or_default::<CompressionConfig>().into();

            Box::new(move |any: &mut dyn Any| {
                let stack = any
                    .downcast_mut::<sword_core::LayerStack<sword_core::State>>()
                    .expect("SwordLayerRegistrar: expected LayerStack<State>");

                stack.push(layer);
            })
        },
        display: |config: &Config| {
            config.get_or_default::<CompressionConfig>().display();
        },
    }
}