Struct oca_bundle_semantics::state::oca::OCABox

pub struct OCABox {
    pub attributes: HashMap<String, Attribute>,
    pub credential_layouts: Option<Vec<Layout>>,
    pub form_layouts: Option<Vec<Layout>>,
    pub mappings: Option<Vec<AttributeMapping>>,
    pub meta: Option<HashMap<Language, HashMap<String, String>>>,
    pub classification: Option<String>,
}

Internal representation of OCA objects in split between non-attributes values and attributes. It is used to build dynamically objects without knowing yet whole structure of the object. Used mainly as a container to hold information while parsing OCAfile. Example of usage:

let oca = OCABox::new() let attr = Attribute::new(“name”) oca.add_attribute(attr) oca.get_attribute_by_name(“name”).setEncoding(Encoding::UTF8) oca.get_attribute_by_name(“name”).setLabel(Language::English, “Name”) oca.get_attribute_by_name(“name”).setInformation(Language::German, “Name”) oca.get_attribute_by_name(“name”).setUnit(“kg”) oca.get_attribute_by_name(“name”).setStandard(“ISO 1234”) oca.get_attribute_by_name(“name”).setCategory(“personal”) oca.generate_bundle().unwrap()

TODO: How to add multiple overlays like mapping or layout (how to identify them?)

Fields

attributes: HashMap<String, Attribute>

credential_layouts: Option<Vec<Layout>>

form_layouts: Option<Vec<Layout>>

mappings: Option<Vec<AttributeMapping>>

meta: Option<HashMap<Language, HashMap<String, String>>>

classification: Option<String>

Implementations

impl OCABox

pub fn new() -> Self

pub fn remove_attribute(&mut self, attr_name: &String)

Remove attribute from the OCA Bundle if attribute does not exist, nothing will happen

pub fn add_attribute(&mut self, attribute: Attribute)

Add an attribute to the OCA Bundle If the attribute already exists, it will be merged with the new attribute for simple types: the new value will overwrite the old value for complex types: the new value will be added to the old value

pub fn get_attribute_by_name(&self, name: &str) -> Option<&Attribute>

pub fn add_attribute_mapping(&mut self, mapping: AttributeMapping)

pub fn add_classification(&mut self, classification: String)

pub fn remove_classification(&mut self)

pub fn generate_bundle(&mut self) -> OCABundle

Trait Implementations

impl Clone for OCABox

fn clone(&self) -> OCABox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CredentialLayouts for OCABox

fn add_credential_layout(&mut self, layout_str: String)

impl Default for OCABox

fn default() -> Self

Returns the “default value” for a type.

impl FormLayouts for OCABox

fn add_form_layout(&mut self, layout_str: String)

impl From<OCABundle> for OCABox

fn from(oca_bundle: OCABundle) -> Self

Converts to this type from the input type.

impl Metas for OCABox

fn add_meta(&mut self, l: Language, key: String, value: String)