Struct garage_util::config::Config

source · [−]

pub struct Config {Show 15 fields
    pub metadata_dir: PathBuf,
    pub data_dir: PathBuf,
    pub block_size: usize,
    pub replication_mode: String,
    pub compression_level: Option<i32>,
    pub rpc_secret: String,
    pub rpc_bind_addr: SocketAddr,
    pub rpc_public_addr: Option<SocketAddr>,
    pub bootstrap_peers: Vec<(NodeID, SocketAddr)>,
    pub consul_host: Option<String>,
    pub consul_service_name: Option<String>,
    pub sled_cache_capacity: u64,
    pub sled_flush_every_ms: u64,
    pub s3_api: ApiConfig,
    pub s3_web: WebConfig,
}

Expand description

Represent the whole configuration

Fields

metadata_dir: PathBuf

Path where to store metadata. Should be fast, but low volume

data_dir: PathBuf

Path where to store data. Can be slower, but need higher volume

block_size: usize

Size of data blocks to save to disk

replication_mode: String

Replication mode. Supported values:

none, 1 -> no replication
2 -> 2-way replication
3 -> 3-way replication

compression_level: Option<i32>

Zstd compression level used on data blocks

rpc_secret: String

RPC secret key: 32 bytes hex encoded

rpc_bind_addr: SocketAddr

Address to bind for RPC

rpc_public_addr: Option<SocketAddr>

Public IP address of this node

bootstrap_peers: Vec<(NodeID, SocketAddr)>

Bootstrap peers RPC address

consul_host: Option<String>

Consul host to connect to to discover more peers

consul_service_name: Option<String>

Consul service name to use

sled_cache_capacity: u64

Sled cache size, in bytes

sled_flush_every_ms: u64

Sled flush interval in milliseconds

s3_api: ApiConfig

Configuration for S3 api

s3_web: WebConfig

Configuration for serving files as normal web server

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Config

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Config

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,