docs(tvix/store): address cargo doc warnings
Fix some broken link references. Change-Id: I69c9b2b62af35bb777e4df1a01ba3181a368be47 Reviewed-on: https://cl.tvl.fyi/c/depot/+/9214 Reviewed-by: tazjin <tazjin@tvl.su> Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI
This commit is contained in:
		
							parent
							
								
									9bbda4421e
								
							
						
					
					
						commit
						583cdec3d8
					
				
					 5 changed files with 12 additions and 11 deletions
				
			
		| 
						 | 
					@ -10,7 +10,7 @@ use super::{BlobService, GRPCBlobService, MemoryBlobService, SledBlobService};
 | 
				
			||||||
/// - `sled://` ([SledBlobService])
 | 
					/// - `sled://` ([SledBlobService])
 | 
				
			||||||
/// - `grpc+*://` ([GRPCBlobService])
 | 
					/// - `grpc+*://` ([GRPCBlobService])
 | 
				
			||||||
///
 | 
					///
 | 
				
			||||||
/// See their [from_url] methods for more details about their syntax.
 | 
					/// See their `from_url` methods for more details about their syntax.
 | 
				
			||||||
pub fn from_addr(uri: &str) -> Result<Arc<dyn BlobService>, crate::Error> {
 | 
					pub fn from_addr(uri: &str) -> Result<Arc<dyn BlobService>, crate::Error> {
 | 
				
			||||||
    let url = Url::parse(uri)
 | 
					    let url = Url::parse(uri)
 | 
				
			||||||
        .map_err(|e| crate::Error::StorageError(format!("unable to parse url: {}", e)))?;
 | 
					        .map_err(|e| crate::Error::StorageError(format!("unable to parse url: {}", e)))?;
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -51,5 +51,5 @@ pub trait BlobWriter: io::Write + Send + Sync + 'static {
 | 
				
			||||||
/// A [io::Read] that also allows seeking.
 | 
					/// A [io::Read] that also allows seeking.
 | 
				
			||||||
pub trait BlobReader: io::Read + io::Seek + Send + 'static {}
 | 
					pub trait BlobReader: io::Read + io::Seek + Send + 'static {}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/// A Cursor<Vec<u8>> can be used as a BlobReader.
 | 
					/// A [`io::Cursor<Vec<u8>>`] can be used as a BlobReader.
 | 
				
			||||||
impl BlobReader for io::Cursor<Vec<u8>> {}
 | 
					impl BlobReader for io::Cursor<Vec<u8>> {}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -46,9 +46,9 @@ pub trait DirectoryService: Send + Sync {
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/// Provides a handle to put a closure of connected [proto::Directory] elements.
 | 
					/// Provides a handle to put a closure of connected [proto::Directory] elements.
 | 
				
			||||||
///
 | 
					///
 | 
				
			||||||
/// The consumer can periodically call [put], starting from the leaves. Once
 | 
					/// The consumer can periodically call [DirectoryPutter::put], starting from the
 | 
				
			||||||
/// the root is reached, [close] can be called to retrieve the root digest (or
 | 
					/// leaves. Once the root is reached, [DirectoryPutter::close] can be called to
 | 
				
			||||||
/// an error).
 | 
					/// retrieve the root digest (or an error).
 | 
				
			||||||
pub trait DirectoryPutter {
 | 
					pub trait DirectoryPutter {
 | 
				
			||||||
    /// Put a individual [proto::Directory] into the store.
 | 
					    /// Put a individual [proto::Directory] into the store.
 | 
				
			||||||
    /// Error semantics and behaviour is up to the specific implementation of
 | 
					    /// Error semantics and behaviour is up to the specific implementation of
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -41,12 +41,12 @@ use self::inode_tracker::InodeTracker;
 | 
				
			||||||
/// This means, we need to have a stable mapping of inode numbers to the
 | 
					/// This means, we need to have a stable mapping of inode numbers to the
 | 
				
			||||||
/// corresponding store nodes.
 | 
					/// corresponding store nodes.
 | 
				
			||||||
///
 | 
					///
 | 
				
			||||||
/// We internally delegate all inode allocation and state keeping to a
 | 
					/// We internally delegate all inode allocation and state keeping to the
 | 
				
			||||||
/// [InodeTracker], and store the currently "explored" store paths together with
 | 
					/// inode tracker, and store the currently "explored" store paths together with
 | 
				
			||||||
/// root inode of the root.
 | 
					/// root inode of the root.
 | 
				
			||||||
///
 | 
					///
 | 
				
			||||||
/// There's some places where inodes are allocated / data inserted into
 | 
					/// There's some places where inodes are allocated / data inserted into
 | 
				
			||||||
/// [self.inode_tracker], if not allocated before already:
 | 
					/// the inode tracker, if not allocated before already:
 | 
				
			||||||
///  - Processing a `lookup` request, either in the mount root, or somewhere
 | 
					///  - Processing a `lookup` request, either in the mount root, or somewhere
 | 
				
			||||||
///    deeper
 | 
					///    deeper
 | 
				
			||||||
///  - Processing a `readdir` request
 | 
					///  - Processing a `readdir` request
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -130,9 +130,10 @@ fn process_entry(
 | 
				
			||||||
/// interacting with a [BlobService] and [DirectoryService].
 | 
					/// interacting with a [BlobService] and [DirectoryService].
 | 
				
			||||||
/// It returns the root node or an error.
 | 
					/// It returns the root node or an error.
 | 
				
			||||||
///
 | 
					///
 | 
				
			||||||
/// It's not interacting with a [PathInfoService], it's up to the caller to
 | 
					/// It's not interacting with a
 | 
				
			||||||
/// possibly register it somewhere (and potentially rename it based on some
 | 
					/// [PathInfoService](crate::pathinfoservice::PathInfoService), it's up to the
 | 
				
			||||||
/// naming scheme.
 | 
					/// caller to possibly register it somewhere (and potentially rename it based on
 | 
				
			||||||
 | 
					/// some naming scheme.
 | 
				
			||||||
#[instrument(skip(blob_service, directory_service), fields(path=?p))]
 | 
					#[instrument(skip(blob_service, directory_service), fields(path=?p))]
 | 
				
			||||||
pub fn ingest_path<P: AsRef<Path> + Debug>(
 | 
					pub fn ingest_path<P: AsRef<Path> + Debug>(
 | 
				
			||||||
    blob_service: Arc<dyn BlobService>,
 | 
					    blob_service: Arc<dyn BlobService>,
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue