terracotta 0.4.2

Boilerplate webserver application based on Axum
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

#![allow(clippy::exhaustive_structs, reason = "Configuration structs")]

//! Configuration for the assets-serving functionality.



//		Packages																										

use crate::app::config::LoadingBehavior;
use serde::{Deserialize, Serialize};
use smart_default::SmartDefault;
use std::path::PathBuf;



//		Structs																											

//		Config																	
/// The configuration options for gathering and processing statistics.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, SmartDefault)]
pub struct Config {
	//		Public properties													
	/// Loading configuration for protected static assets.
	#[serde(rename = "protected")]
	pub protected_assets: ProtectedAssets,
	
	/// Loading configuration for public static assets.
	#[serde(rename = "public")]
	pub public_assets:    PublicAssets,
	
	/// The configuration options for serving static files.
	pub static_files:     StaticFiles,
}

//		ProtectedAssets															
/// Loading configuration for protected static assets.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, SmartDefault)]
pub struct ProtectedAssets {
	//		Public properties													
	/// The loading behaviour for local, non-baked-in protected static assets.
	/// This allows local assets to be used to complement the baked-in assets.
	#[default(LoadingBehavior::Deny)]
	pub behavior:   LoadingBehavior,
	
	/// The path to the local, non-baked-in protected static assets.
	#[default = "content"]
	pub local_path: PathBuf,
}

//		PublicAssets															
/// Loading configuration for public static assets.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, SmartDefault)]
pub struct PublicAssets {
	//		Public properties													
	/// The loading behaviour for local, non-baked-in public static assets. This
	/// allows local assets to be used to complement the baked-in assets.
	#[default(LoadingBehavior::Deny)]
	pub behavior:   LoadingBehavior,
	
	/// The path to the local, non-baked-in public static assets.
	#[default = "static"]
	pub local_path: PathBuf,
}

//		StaticFiles																
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize, SmartDefault)]
/// The configuration options for serving static files.
pub struct StaticFiles {
	//		Public properties													
	/// The file size at which to start streaming, in KB. Below this size, the
	/// file will be read into memory and served all at once.
	#[default = 1_000]
	pub stream_threshold: usize,
	
	/// The size of the stream buffer to use when streaming files, in KB.
	#[default = 256]
	pub stream_buffer:    usize,
	
	/// The size of the read buffer to use when streaming files, in KB.
	#[default = 128]
	pub read_buffer:      usize,
}