Struct SQLiteReader

pub struct SQLiteReader { /* private fields */ }

Reader to load stack graphs and partial paths from a SQLite database.

Implementations

impl SQLiteReader

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a file database.

pub fn clear(&mut self)

Clear all data that has been loaded into this reader instance. After this call, all existing handles from this reader are invalid.

pub fn clear_paths(&mut self)

Clear path data that has been loaded into this reader instance. After this call, all node handles remain valid, but all path data is invalid.

pub fn status_for_file<T: AsRef<str>>( &mut self, file: &str, tag: Option<T>, ) -> Result<FileStatus>

Get the file’s status in the database. If a tag is provided, it must match or the file is reported missing.

pub fn list_all<'a>(&'a mut self) -> Result<Files<'a, ()>>

Returns a Files value that can be used to iterate over all files in the database.

pub fn list_file_or_directory<'a>( &'a self, file_or_directory: &Path, ) -> Result<Files<'a, [String; 1]>>

Returns a Files value that can be used to iterate over all descendants of a file or directory in the database.

pub fn load_graph_for_file(&mut self, file: &str) -> Result<Handle<File>>

Ensure the graph for the given file is loaded.

pub fn load_graphs_for_file_or_directory( &mut self, file_or_directory: &Path, cancellation_flag: &dyn CancellationFlag, ) -> Result<()>

pub fn load_partial_path_extensions( &mut self, path: &PartialPath, cancellation_flag: &dyn CancellationFlag, ) -> Result<()>

Ensure all possible extensions for the given partial path are loaded.

pub fn get(&mut self) -> (&mut StackGraph, &mut PartialPaths, &mut Database)

Get the stack graph, partial paths arena, and path database for the currently loaded data.

pub fn stats(&self) -> Stats

Return stats about this database reader.

Trait Implementations

impl ForwardCandidates<Handle<PartialPath>, PartialPath, Database, StorageError> for SQLiteReader

fn load_forward_candidates( &mut self, path: &PartialPath, cancellation_flag: &dyn CancellationFlag, ) -> Result<(), StorageError>

Load possible forward candidates for the given partial path into this candidates instance. Must be called before [get_forward_candidates] to allow lazy-loading implementations.

fn get_forward_candidates<R>(&mut self, path: &PartialPath, result: &mut R)

where R: Extend<Handle<PartialPath>>,

Get forward candidates for extending the given partial path and add them to the provided result instance. If this instance loads data lazily, this only considers previously loaded data.

fn get_joining_candidate_degree(&self, path: &PartialPath) -> Degree

Get the number of available candidates that share the given path’s end node.

fn get_graph_partials_and_db( &mut self, ) -> (&StackGraph, &mut PartialPaths, &Database)

Get the graph, partial path arena, and database backing this candidates instance.