Uni20
Asynchronous tensor and runtime library.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
uni20::metadata_document Class Reference

Ordered, uniquely identified metadata. Copies are independent snapshots. More...

#include <metadata.hpp>

Public Member Functions

void add (std::string const &group, std::string id, metadata_value value, metadata_field_options options={})
 
void append (metadata_document const &other)
 Append disjoint groups from an owned snapshot, rejecting all collisions before mutation.
 
metadata_field const * find (std::string_view id) const
 
void group (std::string id, std::string label={})
 
std::vector< metadata_group > const & groups () const
 
void replace (std::string const &id, metadata_value value)
 
presentation::table_metadata strings (std::map< std::string, std::string > const &keys={}) const
 Explicitly project to the table format's flat string metadata, checking export-key collisions.
 

Detailed Description

Ordered, uniquely identified metadata. Copies are independent snapshots.

Member Function Documentation

◆ add()

void uni20::metadata_document::add ( std::string const &  group,
std::string  id,
metadata_value  value,
metadata_field_options  options = {} 
)
inline

◆ append()

void uni20::metadata_document::append ( metadata_document const &  other)
inline

Append disjoint groups from an owned snapshot, rejecting all collisions before mutation.

◆ find()

metadata_field const * uni20::metadata_document::find ( std::string_view  id) const
inline

◆ group()

void uni20::metadata_document::group ( std::string  id,
std::string  label = {} 
)
inline

◆ groups()

std::vector< metadata_group > const & uni20::metadata_document::groups ( ) const
inline

◆ replace()

void uni20::metadata_document::replace ( std::string const &  id,
metadata_value  value 
)
inline

◆ strings()

presentation::table_metadata uni20::metadata_document::strings ( std::map< std::string, std::string > const &  keys = {}) const
inline

Explicitly project to the table format's flat string metadata, checking export-key collisions.


The documentation for this class was generated from the following file: