aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTrinity Pointard <trinity.pointard@gmail.com>2021-03-22 00:01:44 +0100
committerAlex Auvolat <alex@adnab.me>2021-04-27 16:37:10 +0200
commitf8716895715b1a552750062aca9bc1882f6f95c0 (patch)
tree8babe2acf622b55e88cc34fcb0ed81745d14aa8a
parent8e0524ae15e5252aecd30dc01d6993810cf49811 (diff)
downloadgarage-f8716895715b1a552750062aca9bc1882f6f95c0.tar.gz
garage-f8716895715b1a552750062aca9bc1882f6f95c0.zip
run cargo fmt on util and make missing doc warning
-rw-r--r--src/rpc/lib.rs2
-rw-r--r--src/util/background.rs6
-rw-r--r--src/util/config.rs42
-rw-r--r--src/util/data.rs14
4 files changed, 32 insertions, 32 deletions
diff --git a/src/rpc/lib.rs b/src/rpc/lib.rs
index 38326077..308baa83 100644
--- a/src/rpc/lib.rs
+++ b/src/rpc/lib.rs
@@ -1,4 +1,4 @@
-#![deny(missing_crate_level_docs, missing_docs)]
+#![warn(missing_crate_level_docs, missing_docs)]
//! Crate containing rpc related functions and types used in Garage
#[macro_use]
diff --git a/src/util/background.rs b/src/util/background.rs
index 3cbcac2a..bfdaaf1e 100644
--- a/src/util/background.rs
+++ b/src/util/background.rs
@@ -21,7 +21,7 @@ pub struct BackgroundRunner {
}
impl BackgroundRunner {
- /// Create a new BackgroundRunner
+ /// Create a new BackgroundRunner
pub fn new(
n_runners: usize,
stop_signal: watch::Receiver<bool>,
@@ -117,8 +117,8 @@ impl BackgroundRunner {
.unwrap();
}
- /// Spawn a task to be run in background. It may get discarded before running if spawned while
- /// the runner is stopping
+ /// Spawn a task to be run in background. It may get discarded before running if spawned while
+ /// the runner is stopping
pub fn spawn_cancellable<T>(&self, job: T)
where
T: Future<Output = JobOutput> + Send + 'static,
diff --git a/src/util/config.rs b/src/util/config.rs
index fcbb32a9..bb70467b 100644
--- a/src/util/config.rs
+++ b/src/util/config.rs
@@ -10,79 +10,79 @@ use crate::error::Error;
/// Represent the whole configuration
#[derive(Deserialize, Debug, Clone)]
pub struct Config {
- /// Path where to store metadata. Should be fast, but low volume
+ /// Path where to store metadata. Should be fast, but low volume
pub metadata_dir: PathBuf,
- /// Path where to store data. Can be slower, but need higher volume
+ /// Path where to store data. Can be slower, but need higher volume
pub data_dir: PathBuf,
- /// Address to bind for RPC
+ /// Address to bind for RPC
pub rpc_bind_addr: SocketAddr,
- /// Bootstrap peers RPC address
+ /// Bootstrap peers RPC address
#[serde(deserialize_with = "deserialize_vec_addr")]
pub bootstrap_peers: Vec<SocketAddr>,
- /// Consule host to connect to to discover more peers
+ /// Consule host to connect to to discover more peers
pub consul_host: Option<String>,
- /// Consul service name to use
+ /// Consul service name to use
pub consul_service_name: Option<String>,
- /// Max number of concurrent RPC request
+ /// Max number of concurrent RPC request
#[serde(default = "default_max_concurrent_rpc_requests")]
pub max_concurrent_rpc_requests: usize,
- /// Size of data blocks to save to disk
+ /// Size of data blocks to save to disk
#[serde(default = "default_block_size")]
pub block_size: usize,
#[serde(default = "default_control_write_max_faults")]
pub control_write_max_faults: usize,
- /// How many nodes should hold a copy of meta data
+ /// How many nodes should hold a copy of meta data
#[serde(default = "default_replication_factor")]
pub meta_replication_factor: usize,
- /// How many nodes should hold a copy of data
+ /// How many nodes should hold a copy of data
#[serde(default = "default_replication_factor")]
pub data_replication_factor: usize,
- /// Configuration for RPC TLS
+ /// Configuration for RPC TLS
pub rpc_tls: Option<TlsConfig>,
- /// Configuration for S3 api
+ /// Configuration for S3 api
pub s3_api: ApiConfig,
- /// Configuration for serving files as normal web server
+ /// Configuration for serving files as normal web server
pub s3_web: WebConfig,
}
/// Configuration for RPC TLS
#[derive(Deserialize, Debug, Clone)]
pub struct TlsConfig {
- /// Path to certificate autority used for all nodes
+ /// Path to certificate autority used for all nodes
pub ca_cert: String,
- /// Path to public certificate for this node
+ /// Path to public certificate for this node
pub node_cert: String,
- /// Path to private key for this node
+ /// Path to private key for this node
pub node_key: String,
}
/// Configuration for S3 api
#[derive(Deserialize, Debug, Clone)]
pub struct ApiConfig {
- /// Address and port to bind for api serving
+ /// Address and port to bind for api serving
pub api_bind_addr: SocketAddr,
- /// S3 region to use
+ /// S3 region to use
pub s3_region: String,
}
/// Configuration for serving files as normal web server
#[derive(Deserialize, Debug, Clone)]
pub struct WebConfig {
- /// Address and port to bind for web serving
+ /// Address and port to bind for web serving
pub bind_addr: SocketAddr,
- /// Suffix to remove from domain name to find bucket
+ /// Suffix to remove from domain name to find bucket
pub root_domain: String,
- /// Suffix to add when user-agent request path end with "/"
+ /// Suffix to add when user-agent request path end with "/"
pub index: String,
}
diff --git a/src/util/data.rs b/src/util/data.rs
index b269edac..34ee8a18 100644
--- a/src/util/data.rs
+++ b/src/util/data.rs
@@ -63,20 +63,20 @@ impl Serialize for FixedBytes32 {
}
impl FixedBytes32 {
- /// Access the content as a slice
+ /// Access the content as a slice
pub fn as_slice(&self) -> &[u8] {
&self.0[..]
}
- /// Access the content as a mutable slice
+ /// Access the content as a mutable slice
pub fn as_slice_mut(&mut self) -> &mut [u8] {
&mut self.0[..]
}
- /// Copy to a slice
+ /// Copy to a slice
pub fn to_vec(&self) -> Vec<u8> {
self.0.to_vec()
}
- /// Try building a FixedBytes32 from a slice
- /// Return None if the slice is not 32 bytes long
+ /// Try building a FixedBytes32 from a slice
+ /// Return None if the slice is not 32 bytes long
pub fn try_from(by: &[u8]) -> Option<Self> {
if by.len() != 32 {
return None;
@@ -151,8 +151,8 @@ pub fn debug_serialize<T: Serialize>(x: T) -> String {
match serde_json::to_string(&x) {
Ok(ss) => {
if ss.len() > 100 {
- // TODO this can panic if 100 is not a codepoint boundary, but inside a 2 Bytes
- // (or more) codepoint
+ // TODO this can panic if 100 is not a codepoint boundary, but inside a 2 Bytes
+ // (or more) codepoint
ss[..100].to_string()
} else {
ss