Struct graphannis_core::annostorage::ondisk::AnnoStorageImpl

pub struct AnnoStorageImpl<T> where
    T: FixedSizeKeySerializer + Send + Sync + MallocSizeOf + Clone + Serialize + DeserializeOwned,  { /* private fields */ }

An on-disk implementation of an annotation storage.

Implementations

impl<T> AnnoStorageImpl<T> where
    T: FixedSizeKeySerializer + Send + Sync + MallocSizeOf + Clone + Default + Serialize + DeserializeOwned,
    (T, Arc<AnnoKey>): Into<Match>, 

pub fn new(path: Option<PathBuf>) -> Result<AnnoStorageImpl<T>>

Trait Implementations

impl<'de, T> AnnotationStorage<T> for AnnoStorageImpl<T> where
    T: FixedSizeKeySerializer + Send + Sync + MallocSizeOf + PartialOrd + Clone + Default + Serialize + DeserializeOwned,
    (T, Arc<AnnoKey>): Into<Match>, 

fn insert(&mut self, item: T, anno: Annotation) -> Result<()>

Insert an annotation anno (with annotation key and value) for an item item.

fn get_annotations_for_item(&self, item: &T) -> Result<Vec<Annotation>>

Get all annotations for an item (node or edge).

fn remove_annotation_for_item(
    &mut self,
    item: &T,
    key: &AnnoKey
) -> Result<Option<Cow<'_, str>>>

Remove the annotation given by its key for a specific item Returns the value for that annotation, if it existed.

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

Remove all annotations.

fn get_qnames(&self, name: &str) -> Result<Vec<AnnoKey>>

Get all qualified annotation names (including namespace) for a given annotation name

fn number_of_annotations(&self) -> Result<usize>

Return the total number of annotations contained in this AnnotationStorage.

fn is_empty(&self) -> Result<bool>

Return true if there are no annotations in this AnnotationStorage.

fn get_value_for_item(
    &self,
    item: &T,
    key: &AnnoKey
) -> Result<Option<Cow<'_, str>>>

Get the annotation for a given item and the annotation key.

fn has_value_for_item(&self, item: &T, key: &AnnoKey) -> Result<bool>

Returns true if the given item has an annotation for the given key.

fn get_keys_for_iterator<'b>(
    &'b self,
    ns: Option<&str>,
    name: Option<&str>,
    it: Box<dyn Iterator<Item = Result<T, Box<dyn Error + Send + Sync>>> + 'b>
) -> Result<Vec<Match>>

Get the matching annotation keys for each item in the iterator.

fn number_of_annotations_by_name(
    &self,
    ns: Option<&str>,
    name: &str
) -> Result<usize>

Return the number of annotations contained in this AnnotationStorage filtered by name and optional namespace (ns).

fn exact_anno_search<'a>(
    &'a self,
    namespace: Option<&str>,
    name: &str,
    value: ValueSearch<&str>
) -> Box<dyn Iterator<Item = Result<Match>> + 'a>

Returns an iterator for all items that exactly match the given annotation constraints. The annotation name must be given as argument, the other arguments are optional.

fn regex_anno_search<'a>(
    &'a self,
    namespace: Option<&str>,
    name: &str,
    pattern: &str,
    negated: bool
) -> Box<dyn Iterator<Item = Result<Match>> + 'a>

Returns an iterator for all items where the value matches the regular expression. The annotation name and the pattern for the value must be given as argument, the
namespace argument is optional and can be used as additional constraint.

fn get_all_keys_for_item(
    &self,
    item: &T,
    ns: Option<&str>,
    name: Option<&str>
) -> Result<Vec<Arc<AnnoKey>>>

Get all the annotation keys of a node, filtered by the optional namespace (ns) and name.

fn guess_max_count(
    &self,
    ns: Option<&str>,
    name: &str,
    lower_val: &str,
    upper_val: &str
) -> Result<usize>

Estimate the number of results for an annotation exact search for a given an inclusive value range.

fn guess_max_count_regex(
    &self,
    ns: Option<&str>,
    name: &str,
    pattern: &str
) -> Result<usize>

Estimate the number of results for an annotation regular expression search for a given pattern.

fn guess_most_frequent_value(
    &self,
    ns: Option<&str>,
    name: &str
) -> Result<Option<Cow<'_, str>>>

Estimate the most frequent value for a given annotation name with an optional namespace (ns).

fn get_all_values(
    &self,
    key: &AnnoKey,
    most_frequent_first: bool
) -> Result<Vec<Cow<'_, str>>>

Return a list of all existing values for a given annotation key. If the most_frequent_first parameter is true, the results are sorted by their frequency.

fn annotation_keys(&self) -> Result<Vec<AnnoKey>>

Get all the annotation keys which are part of this annotation storage

fn get_largest_item(&self) -> Result<Option<T>>

Return the item with the largest item which has an annotation value in this annotation storage.

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

(Re-) calculate the internal statistics needed for estimating annotation values.

fn load_annotations_from(&mut self, location: &Path) -> Result<()>

Load the annotation from an external location.

fn save_annotations_to(&self, location: &Path) -> Result<()>

Save the current annotation to a location on the disk, but do not remember this location.

impl<T> MallocSizeOf for AnnoStorageImpl<T> where
    T: FixedSizeKeySerializer + Send + Sync + MallocSizeOf + Clone + Serialize + DeserializeOwned,
    T: MallocSizeOf, 

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.