Struct stam::TextResourceBuilder

pub struct TextResourceBuilder { /* private fields */ }

This is a helper structure to build TextResource instances in a builder pattern. Example:

use stam::*;
let mut store = AnnotationStore::default();
store.insert(
       TextResourceBuilder::new().with_id("testres").with_text(
       "Hello world!",
       ).build().unwrap()
);

Implementations

impl TextResourceBuilder

pub fn new() -> Self

pub fn from_txt_file(filename: &str, config: Config) -> Result<Self, StamError>

Loads a resource from text file

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

Load a resource from file. The extension determines the type (json for STAM JSON or plain text otherwise). You also need to pass a configuration, for which you can often just use Config::default().

pub fn with_id(self, id: impl Into<String>) -> Self

Associate a public identifier with the resource

pub fn with_config(self, config: Config) -> Self

Set a configuration to use for this resource

pub fn with_filename(self, filename: impl Into<String>) -> Self

Set the filename associated with the resource. This does NOT load the resource from file, but merely sets up the association and where to write to. Use Self::from_file() instead if you want to load from file.

pub fn with_text(self, text: impl Into<String>) -> Self

Explicitly sets the text for the resource

pub fn build(self) -> Result<TextResource, StamError>

Builds a new TextResource from TextResourceBuilder, consuming the latter

Trait Implementations

impl Debug for TextResourceBuilder

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

Formats the value using the given formatter.

impl Default for TextResourceBuilder

fn default() -> TextResourceBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextResourceBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromJson for TextResourceBuilder

fn from_json_file(filename: &str, config: Config) -> Result<Self, StamError>

Loads a Text Resource from a STAM JSON or plain text file file. If the file is JSON, it file must contain a single object which has “@type”: “TextResource” If include is true, the file will be included via the @include mechanism, and is kept external upon serialization

fn from_json_str(string: &str, config: Config) -> Result<Self, StamError>

Loads a text resource from a STAM JSON string The string must contain a single object which has “@type”: “TextResource”

fn merge_json_file(&mut self, _filename: &str) -> Result<(), StamError>

fn merge_json_str(&mut self, _string: &str) -> Result<(), StamError>

impl TryFrom<TextResourceBuilder> for TextResource

type Error = StamError

The type returned in the event of a conversion error.

fn try_from(builder: TextResourceBuilder) -> Result<Self, StamError>

Performs the conversion.

impl TypeInfo for TextResourceBuilder

fn typeinfo() -> Type

Return the type (introspection).

fn temp_id_prefix() -> &'static str

Return the prefix for temporary identifiers of this type