Struct stam::AnnotationDataSetBuilder

pub struct AnnotationDataSetBuilder<'a> { /* private fields */ }

Implementations

impl<'a> AnnotationDataSetBuilder<'a>

pub fn new() -> Self

Start a new builder to build an AnnotationDataSet. You can chain various with_* methods and subsequently call build() to produce the actual AnnotationDataSet.

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

Loads an AnnotationDataSetBuilder from file (STAM JSON or other supported format). For STAM JSON, the file must contain a single object which has “@type”: “AnnotationDataSet”

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

Set the public ID for the AnnotationDataSet that will be built.

pub fn with_keys(self, keys: Vec<DataKey>) -> Self

Adds multiple keys at once. This can only be called once (it will override any prior set keys)

pub fn with_key(self, key: DataKey) -> Self

Adds a data key. This can be called multiple times.

pub fn with_data_builders(self, data: Vec<AnnotationDataBuilder<'a>>) -> Self

Adds multiple data builder at once. This can only be called once (it will override any prior set keys)

pub fn with_data(self, data: AnnotationDataBuilder<'a>) -> Self

Adds a data builder. This can be called multiple times.

pub fn with_filename(self, filename: &str) -> Self

Set the filename for the AnnotationDataSet that will be built. This does not load from file. Use AnnotationDataSet::from_file() instead of this builder if that’s what you want.

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

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

Final builder method, constructs the [’AnnotationDataSet`], consuming the builder

Trait Implementations

impl<'a> Default for AnnotationDataSetBuilder<'a>

fn default() -> AnnotationDataSetBuilder<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for AnnotationDataSetBuilder<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'c, 'a> FromCsv<'c> for AnnotationDataSetBuilder<'a>

fn from_csv_reader( reader: Box<dyn BufRead>, filename: Option<&str>, config: Config ) -> Result<Self, StamError>

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

impl<'j, 'a> FromJson<'j> for AnnotationDataSetBuilder<'a>

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

Loads an AnnotationDataSet from a STAM JSON file, as a builder The file must contain a single object which has “@type”: “AnnotationDataSet” If include is true, the file will be included via the @include mechanism, and is kept external upon serialization If workdir is set, the file will be searched for in the workdir if needed

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

Loads an AnnotationDataSet from a STAM JSON string The string must contain a single object which has “@type”: “AnnotationDataSet”

impl<'a> TryFrom<AnnotationDataSetBuilder<'a>> for AnnotationDataSet

type Error = StamError

The type returned in the event of a conversion error.

fn try_from(builder: AnnotationDataSetBuilder<'a>) -> Result<Self, StamError>

Performs the conversion.

impl<'a> TypeInfo for AnnotationDataSetBuilder<'a>

fn typeinfo() -> Type