genegraph-storage 0.2.1

vector database: base Lance storage
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use std::path::PathBuf;

use crate::StorageError;
use crate::metadata::FileInfo;
use crate::metadata::GeneMetadata;
use crate::traits::backend::StorageBackend;

/// A trait to create metadata structures.
/// Instantiate structures with this trait, like for `GeneMetaData`
pub trait Metadata {
    /// constructor
    fn new(name_id: &str) -> Self;
    /// instantiate a new file info instance for this Metadata type
    fn new_fileinfo(
        &self,
        key: &str,
        filetype: &str,
        data_shape: (usize, usize),
        nnz: Option<usize>,
        size_bytes: Option<u64>,
    ) -> FileInfo;

    /// Standard pipeline object
    async fn seed_metadata<B: StorageBackend>(
        name_id: &str,
        nitems: usize,
        nfeatures: usize,
        storage: &B,
    ) -> Result<GeneMetadata, StorageError>;

    /// add a file to the metadata files
    fn add_file(self, key: &str, info: FileInfo) -> Self;

    // constructor helpers
    fn with_base(self, base_path: PathBuf) -> Self;
    fn with_dimensions(self, rows: usize, cols: usize) -> Self;
}