From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 5B61A603D4 for ; Wed, 7 Oct 2020 13:53:16 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0D0862E294 for ; Wed, 7 Oct 2020 13:53:16 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 28F4A2E258 for ; Wed, 7 Oct 2020 13:53:14 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E516645C3F for ; Wed, 7 Oct 2020 13:53:13 +0200 (CEST) From: Stefan Reiter To: pbs-devel@lists.proxmox.com Date: Wed, 7 Oct 2020 13:53:03 +0200 Message-Id: <20201007115308.6275-3-s.reiter@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20201007115308.6275-1-s.reiter@proxmox.com> References: <20201007115308.6275-1-s.reiter@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.041 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup 2/7] fuse_loop: add documentation X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 07 Oct 2020 11:53:16 -0000 Signed-off-by: Stefan Reiter --- src/tools/fuse_loop.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/tools/fuse_loop.rs b/src/tools/fuse_loop.rs index 8c1e04aa..cdad0230 100644 --- a/src/tools/fuse_loop.rs +++ b/src/tools/fuse_loop.rs @@ -1,3 +1,5 @@ +//! Map a raw data reader as a loop device via FUSE + use anyhow::{Error, format_err, bail}; use std::ffi::OsStr; use std::path::{Path, PathBuf}; @@ -18,6 +20,10 @@ use super::loopdev; const RUN_DIR: &'static str = "/run/pbs-loopdev"; +/// Represents an ongoing FUSE-session that has been mapped onto a loop device. +/// Create with map_loop, then call 'main' and poll until startup_chan reports +/// success. Then, daemonize or otherwise finish setup, and continue polling +/// main's future until completion. pub struct FuseLoopSession { session: Option, stat: libc::stat, -- 2.20.1