diff options
| author | Trinity Pointard <trinity.pointard@gmail.com> | 2021-03-26 21:53:28 +0100 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2021-04-27 16:37:10 +0200 |
| commit | 67585a4ffab14ba7c4b7c6dca530c177059a91d9 (patch) | |
| tree | 6fd0339f8d7f651553145a3c29decc56e29c23bd /src/model/garage.rs | |
| parent | b4376108122bb09bd8cff562b718967d4332ffbe (diff) | |
| download | garage-67585a4ffab14ba7c4b7c6dca530c177059a91d9.tar.gz garage-67585a4ffab14ba7c4b7c6dca530c177059a91d9.zip | |
attempt at documenting model crate
Diffstat (limited to 'src/model/garage.rs')
| -rw-r--r-- | src/model/garage.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/model/garage.rs b/src/model/garage.rs index 3f51f9fe..797a91e5 100644 --- a/src/model/garage.rs +++ b/src/model/garage.rs @@ -18,15 +18,23 @@ use crate::key_table::*; use crate::object_table::*; use crate::version_table::*; +/// An entire Garage full of data pub struct Garage { + /// The parsed configuration Garage is running pub config: Config, + /// The local database pub db: sled::Db, + /// A background job runner pub background: Arc<BackgroundRunner>, + /// The membership manager pub system: Arc<System>, + /// The block manager pub block_manager: Arc<BlockManager>, + /// Table containing informations about buckets pub bucket_table: Arc<Table<BucketTable, TableFullReplication>>, + /// Table containing informations about api keys pub key_table: Arc<Table<KeyTable, TableFullReplication>>, pub object_table: Arc<Table<ObjectTable, TableShardedReplication>>, @@ -35,6 +43,7 @@ pub struct Garage { } impl Garage { + /// Create and run garage pub fn new( config: Config, db: sled::Db, |