rust/neon
1
0
Fork 0
mirror of https://github.com/neondatabase/neon.git synced 2026-01-15 09:22:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: explain DownloadedLayer::get owner param

Browse Source
This commit is contained in:
Joonas Koivunen
2023-08-29 11:07:14 +03:00
parent 282372aa5a
commit cd1b548a8f
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pageserver/src/tenant/storage_layer/layer.rs
View File

@@ -1003,9 +1003,12 @@ impl Drop for DownloadedLayer {
}
impl DownloadedLayer {
/// The owner is required so that we don't have to upgrade the `Self::owner`, which will only
/// be used on drop. This way, initializing a DownloadedLayer with the owner gone is
/// impossible.
/// Initializes the `DeltaLayerInner` or `ImageLayerInner` within [`LayerKind`], or fails to
/// initialize it permanently.
///
/// `owner` parameter is a borrow pointing at the same `LayerInner` as the
/// `DownloadedLayer::owner` would point when upgraded. Given how this method ends up called,
/// we will however always have the LayerInner on the callstack, so we can just use it.
async fn get(&self, owner: &LayerInner) -> anyhow::Result<&LayerKind> {
let init = || async {
// there is nothing async here, but it should be async