Struct LinkStorage 

pub struct LinkStorage { /* private fields */ }

LinkStorage provides persistent storage for links Corresponds to the storage functionality in NamedLinksDecorator in C#

Implementations

impl LinkStorage

pub fn new<P: AsRef<Path>>(db_path: P, trace: bool) -> Result<Self>

Creates a new LinkStorage instance

The database location is accepted as any AsRef<Path>, so embedding applications can pass a PathBuf (or an OsStr on platforms with non-UTF-8 paths) instead of a &str.

pub fn database_path(&self) -> &Path

The database file this storage reads from and writes to.

pub fn observed_revision(&self) -> StorageRevision

The revision of the database file observed at the last load or save.

pub fn refresh_observed_revision(&mut self) -> Result<(), LinkError>

Re-reads the database file’s revision fingerprint, marking the current on-disk state as “seen” for LinksStorage::has_external_changes.

pub fn reload_from_disk(&mut self) -> Result<()>

Discards in-memory state and re-reads the database file.

pub fn save(&self) -> Result<()>

Saves all links to the database file

pub fn create(&mut self, source: u32, target: u32) -> u32

Creates a new link and returns its ID

pub fn ensure_created(&mut self, id: u32) -> u32

Creates a link with a specific ID, ensuring all links up to that ID exist

pub fn get(&self, id: u32) -> Option<&Link>

Gets a link by ID

pub fn exists(&self, id: u32) -> bool

Checks if a link exists

pub fn update(&mut self, id: u32, source: u32, target: u32) -> Result<Link>

Updates a link’s source and target

pub fn delete(&mut self, id: u32) -> Result<Link>

Deletes a link by ID

pub fn all(&self) -> Vec<&Link>

Returns all links

pub fn query( &self, index: Option<u32>, source: Option<u32>, target: Option<u32>, ) -> Vec<&Link>

Returns all links matching a query pattern

pub fn search(&self, source: u32, target: u32) -> Option<u32>

Searches for a link with the given source and target

pub fn get_or_create(&mut self, source: u32, target: u32) -> u32

Gets or creates a link with the given source and target

pub fn format(&self, link: &Link) -> String

Formats a link for display

pub fn format_lino(&self, link: &Link) -> String

Formats a link as LiNo suitable for database export.

pub fn lino_lines(&self) -> Vec<String>

Returns all database links as sorted LiNo lines.

pub fn write_lino_output<P: AsRef<Path>>(&self, path: P) -> Result<()>

Writes the complete database as LiNo.

pub fn format_structure(&self, id: u32) -> Result<String>

Formats the structure of a link

pub fn print_all_links(&self)

Prints all links

pub fn print_change(&self, before: &Option<Link>, after: &Option<Link>)

Prints a change (before -> after)

pub fn get_or_create_named(&mut self, name: &str) -> u32

Gets or creates a link with a name

pub fn set_name(&mut self, id: u32, name: &str)

Sets the name for a link

pub fn get_name(&self, id: u32) -> Option<&String>

Gets the name of a link

pub fn get_by_name(&self, name: &str) -> Option<u32>

Gets a link ID by name

pub fn remove_name(&mut self, id: u32)

Removes the name for a link

pub fn is_trace_enabled(&self) -> bool

Returns true if trace mode is enabled

Trait Implementations

impl LinksStorage<u32> for LinkStorage

fn create_link(&mut self, source: u32, target: u32) -> Result<u32, LinkError>

Creates a new link and returns its address.

fn ensure_link_created(&mut self, index: u32) -> Result<u32, LinkError>

Ensures a link exists at index, creating placeholders as needed.

fn get_link(&self, index: u32) -> Option<GenericLink<u32>>

Returns the link stored at index, if any.

fn link_exists(&self, index: u32) -> bool

Returns true when a link exists at index.

fn update_link( &mut self, index: u32, source: u32, target: u32, ) -> Result<GenericLink<u32>, LinkError>

Repoints index at source/target, returning the previous state.

fn delete_link(&mut self, index: u32) -> Result<GenericLink<u32>, LinkError>

Deletes index, returning the link that was removed.

fn all_links(&self) -> Vec<GenericLink<u32>>

Returns every link in the store.

fn query_links( &self, index: Option<u32>, source: Option<u32>, target: Option<u32>, ) -> Vec<GenericLink<u32>>

Returns every link matching the (optional) index/source/target pattern.

fn search_link(&self, source: u32, target: u32) -> Option<u32>

Finds the address of a link with the given source and target.

fn get_or_create_link( &mut self, source: u32, target: u32, ) -> Result<u32, LinkError>

Returns the address of an existing (source, target) link, creating it when it does not exist yet.

fn flush(&mut self) -> Result<(), LinkError>

Makes every write durable on disk.

fn has_external_changes(&self) -> Result<bool, LinkError>

Cheap check for “did another process write to this database since we last read or wrote it?”.

fn reload(&mut self) -> Result<(), LinkError>

Re-reads the database from disk, discarding cached state.

fn links_count(&self) -> usize

Number of links currently stored.

impl LinksStorageRef<u32> for LinkStorage

fn get_link_ref(&self, index: u32) -> Option<&Link>

Borrows the link stored at index.

fn all_link_refs(&self) -> Vec<&Link>

Borrows every link in the store.

fn query_link_refs( &self, index: Option<u32>, source: Option<u32>, target: Option<u32>, ) -> Vec<&Link>

Borrows every link matching the (optional) index/source/target pattern.

impl NamedTypeLinks for LinkStorage

fn create(&mut self, source: u32, target: u32) -> u32

fn ensure_created(&mut self, id: u32) -> u32

fn get_link(&mut self, id: u32) -> Option<Link>

fn exists(&mut self, id: u32) -> bool

fn update(&mut self, id: u32, source: u32, target: u32) -> Result<Link>

fn delete(&mut self, id: u32) -> Result<Link>

fn all_links(&mut self) -> Vec<Link>

fn search(&mut self, source: u32, target: u32) -> Option<u32>

fn get_or_create(&mut self, source: u32, target: u32) -> u32

fn get_name(&mut self, id: u32) -> Result<Option<String>>

fn set_name(&mut self, id: u32, name: &str) -> Result<u32>

fn get_by_name(&mut self, name: &str) -> Result<Option<u32>>

fn remove_name(&mut self, id: u32) -> Result<()>

fn save(&mut self) -> Result<()>

fn get_or_create_named(&mut self, name: &str) -> Result<u32>

fn try_ensure_created(&mut self, id: u32) -> Result<u32>

fn format_reference(&mut self, id: u32) -> Result<String>

fn format_lino(&mut self, link: &Link) -> Result<String>

fn lino_lines(&mut self) -> Result<Vec<String>>

fn write_lino_output<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

fn print_all_lino(&mut self) -> Result<()>

fn print_change_lino( &mut self, before: &Option<Link>, after: &Option<Link>, ) -> Result<()>

fn format_structure(&mut self, id: u32) -> Result<String>

fn format_structure_recursive( &mut self, id: u32, visited: &mut HashSet<u32>, ) -> Result<String>