Struct stam::Config

pub struct Config { /* private fields */ }

This holds the configuration. It is not limited to configuring a single part of the model, but unifies all in a single configuration.

Implementations

impl Config

pub fn new() -> Self

pub fn with_textrelationmap(self, value: bool) -> Self

Enable/disable the reverse index for text, it maps TextResource => TextSelection => Annotation Do not change this on a configuration that is already in use!

pub fn textrelationmap(&self) -> bool

Is the reverse index for text enabled? It maps TextResource => TextSelection => Annotation

pub fn with_resource_annotation_map(self, value: bool) -> Self

Enable/disable reverse index for TextResource => Annotation. Holds only annotations that directly reference the TextResource (via crate::Selector::ResourceSelector), i.e. metadata Do not change this on a configuration that is already in use!

pub fn resource_annotation_map(&self) -> bool

Is the reverse index for TextResource => Annotation enabled? Holds only annotations that directly reference the TextResource (via crate::Selector::ResourceSelector), i.e. metadata

pub fn with_dataset_annotation_map(self, value: bool) -> Self

Enable/disable reverse index for AnnotationDataSet => Annotation. Holds only annotations that directly reference the AnnotationDataSet (via crate::Selector::DataSetSelector), i.e. metadata Do not change this on a configuration that is already in use!

pub fn dataset_annotation_map(&self) -> bool

Is the reverse index for AnnotationDataSet => Annotation enabled?. Holds only annotations that directly reference the AnnotationDataSet (via crate::Selector::DataSetSelector), i.e. metadata

pub fn key_annotation_metamap(&self) -> bool

Is the reverse index for DataKey => Annotation enabled?. Holds only annotations that directly reference the DataKey (via crate::Selector::DataKeySelector), i.e. metadata

pub fn with_key_annotation_metamap(self, value: bool) -> Self

Enable/disable reverse index for DataKey => Annotation. Holds only annotations that directly reference the DataKey (via crate::Selector::DataKeySelector), i.e. metadata Do not change this on a configuration that is already in use!

pub fn data_annotation_metamap(&self) -> bool

Is the reverse index for AnnotationData => Annotation enabled?. Holds only annotations that directly reference the AnnotationData (via crate::Selector::AnnotationDataSelector), i.e. metadata

pub fn with_data_annotation_metamap(self, value: bool) -> Self

Enable/disable reverse index for AnnotationData => Annotation. Holds only annotations that directly reference the AnnotationData (via crate::Selector::AnnotationDataSelector), i.e. metadata Do not change this on a configuration that is already in use!

pub fn with_annotation_annotation_map(self, value: bool) -> Self

Enable/disable index for annotations that reference other annotations Do not change this on a configuration that is already in use!

pub fn annotation_annotation_map(&self) -> bool

Is the index for annotations that reference other annotations enabled?

pub fn with_dataformat(self, value: DataFormat) -> Self

Sets chosen dataformat for serialisation, defaults to STAM JSON. Do not change this on a configuration that is already in use! Use [AnnotationStore.set_filename()] instead.

pub fn with_shrink_to_fit(self, value: bool) -> Self

pub fn with_strip_temp_ids(self, value: bool) -> Self

Strip temporary public identifiers when deserialising?

pub fn dataformat(&self) -> DataFormat

Returns the configured dataformat for serialisation.

pub fn with_generate_ids(self, value: bool) -> Self

Generate public IDs when missing. Each will consist of 21 URL-friendly ASCII symbols after a prefix of A for Annotations, S for DataSets, D for AnnotationData, R for resources

pub fn generate_ids(&self) -> bool

Is generation of public IDs when missing enabled or not?

pub fn strip_temp_ids(&self) -> bool

Strip temporary public identifiers when deserialising?

pub fn shrink_to_fit(&self) -> bool

Shrink data structures for minimal memory footprint?

pub fn with_use_include(self, value: bool) -> Self

Use @include mechanism for STAM JSON, or output all to a single file?

pub fn use_include(&self) -> bool

Use @include mechanism for STAM JSON, or output all to a single file?

pub fn with_milestone_interval(self, value: usize) -> Self

Set the configured milestone interval The Milestone placement interval (in unicode codepoints) is used in indexing text resources. A low number above zero increases search performance at the cost of memory and increased initialisation time.

pub fn milestone_interval(&self) -> usize

Return the configured milestone interval The Milestone placement interval (in unicode codepoints) is used in indexing text resources. A low number above zero increases search performance at the cost of memory and increased initialisation time.

pub fn with_debug(self, value: bool) -> Self

Enable or disable debug mode. In debug mode, verbose output will be printed to standard error output

pub fn debug(&self) -> bool

Is debug mode enabled or not?

pub fn workdir(&self) -> Option<&Path>

Return the working directory, if set

pub fn from_file(filename: &str) -> Result<Self, StamError>

Loads configuration from a JSON file

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'bytes, Ctx> Decode<'bytes, Ctx> for Config

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx ) -> Result<Config, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Ctx> Encode<Ctx> for Config

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToJson for Config

fn to_json_writer<W>(&self, writer: W, compact: bool) -> Result<(), StamError>

where W: Write,

Writes a serialisation (choose a dataformat) to any writer Lower-level function

fn to_json_file(&self, filename: &str, config: &Config) -> Result<(), StamError>

Writes this structure to a file The actual dataformat can be set via config, the default is STAM JSON.

fn to_json_string(&self, config: &Config) -> Result<String, StamError>

Serializes this structure to one string. The actual dataformat can be set via config, the default is STAM JSON. If config not not specified, an attempt to fetch the AnnotationStore’s initial config is made

impl TypeInfo for Config

fn typeinfo() -> Type

Return the type (introspection).

fn temp_id_prefix() -> &'static str

Return the prefix for temporary identifiers of this type