Struct OCABundleModel 

pub struct OCABundleModel {
    pub version: String,
    pub digest: Option<SelfAddressingIdentifier>,
    pub capture_base: CaptureBase,
    pub overlays: Vec<OverlayModel>,
    pub attributes: Option<HashMap<String, Attribute>>,
}

Fields

version: String

CESR version of the OCA Bundle with OCAS prefix

digest: Option<SelfAddressingIdentifier>

capture_base: CaptureBase

overlays: Vec<OverlayModel>

attributes: Option<HashMap<String, Attribute>>

Implementations

impl OCABundleModel

pub fn new( capture_base: CaptureBase, overlays: Vec<OverlayModel>, ) -> OCABundleModel

pub fn to_ast(&self) -> OCAAst

Examples found in repository

examples/generate_ocafile.rs (line 12)

fn main() {
    let bundle_path = "tests/assets/semantics/structural_bundle2.json";
    let bundle_str = fs::read_to_string(bundle_path).expect("failed to read bundle");

    let registry = oca::overlay_file::OverlayLocalRegistry::from_dir("tests/assets/overlay-file/")
        .expect("load overlays");
    let bundle = oca::bundle::load(&mut bundle_str.as_bytes(), &registry).expect("load bundle");
    let ocafile = oca::file::generate_from_ast(&bundle.to_ast());

    println!("{}", ocafile);
}

pub fn fill_attributes(&mut 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 get_attribute_by_name(&self, name: &str) -> Option<&Attribute>

pub fn compute_and_fill_digest( &mut self, ) -> Result<SelfAddressingIdentifier, OCABundleSerializationError>

This method will compute digest for OCABundle and all it’s members (capture_base and each overlay) filling as well capture_base digest into overlays. It would use external structures instead of the internal Models i.e. OCABundle vs OCABundleModel Arguments:

• self - OCABundleModel to compute digest for

Returns:

• Result<said::SelfAddressingIdentifier, OCABundleSerializationError> - Result with computed SAID or an error if serialization or digest computation fails.

Trait Implementations

impl Clone for OCABundleModel

fn clone(&self) -> OCABundleModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OCABundleModel

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

Formats the value using the given formatter.

impl Default for OCABundleModel

fn default() -> OCABundleModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OCABundleModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OCABundleModel> for OCABundle

fn from(model: OCABundleModel) -> OCABundle

Converts to this type from the input type.

impl From<OCABundleWithRegistry> for OCABundleModel

fn from(br: OCABundleWithRegistry) -> OCABundleModel

Converts to this type from the input type.

impl Serialize for OCABundleModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToJSON for OCABundleModel

fn get_json_bundle(&self) -> String

impl WithInfo for OCABundleModel

fn info(&self) -> Arc<OCABundleInfo>