Skip to content

Commit

Permalink
add docs to DatabaseMetadataValue
Browse files Browse the repository at this point in the history
  • Loading branch information
Rjected committed Dec 14, 2023
1 parent 755612d commit b05f534
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions crates/storage/db/src/abstraction/database_metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ impl<DB: DatabaseMetrics> DatabaseMetrics for Arc<DB> {
}

/// The type used to store metadata about the database.
#[derive(Debug)]
#[derive(Debug, Default)]
pub struct DatabaseMetadataValue {
/// The freelist size
freelist_size: Option<usize>,
Expand All @@ -60,10 +60,10 @@ impl DatabaseMetadataValue {
}
}

/// Extends [Database] to include a [Metadata] type, which can be used by methods which need to
/// dynamically retrieve information about the database.
/// Extends [Database] to include a [DatabaseMetadataValue] type, which can be used by methods
/// which need to dynamically retrieve information about the database.
pub trait DatabaseMetadata {
/// TODO
/// Returns a metadata type, [DatabaseMetadataValue] for the database.
fn metadata(&self) -> DatabaseMetadataValue;
}

Expand Down

0 comments on commit b05f534

Please sign in to comment.