Struct CapeArrayStringOutFromProvider

pub struct CapeArrayStringOutFromProvider {
    interface: ICapeArrayString,
    interface_ptr: *mut ICapeArrayString,
}

CapeArrayStringOutFromProvider

When calling a CAPE-OPEN method that takes a CapeArrayString as output, the caller provides an object that implements CapeArrayStringProviderOut, for example CapeArrayStringVec.

The CapeArrayStringOutFromProvider returns an C::ICapeArrayString interface, which has a small life span, enough to make sure that the pointer to this interface is valid. This is done inside wrapper classes such as capeopen_1_2::CapeThermoMaterial.

When implementing a function that gets called, and takes a CapeArrayString as output, it received a &mut CapeArrayStringOut typed argument, which is constructed from the reference to an C::ICapeArrayString interface pointer.

Typically a function call receives the C::ICapeArrayString interface from the caller, and from this, the CapeArrayStringOut is constructed by the cape_object_implementation macro.

In the rare case that one wants to call an internal CAPE-OPEN function directly, one needs to provide the class that implements the CapeArrayStringProviderOut trait, allocate the pointer, point to it, and construct the CapeArrayStringOut object from a reference to that pointer.

The CapeArrayStringOutFromProvider class does all this.

Example

use cobia::*;
let mut array = CapeArrayStringVec::new();
fn SetArrayOut(array:&mut CapeArrayStringOut) {
    array.put_array(&["Hello","World"]);
}
SetArrayOut(&mut CapeArrayStringOutFromProvider::from(&mut array).as_cape_array_string_out()); //this is how array is passed as &mut CapeArrayStringOut argument
assert_eq!(array.as_string_vec(),vec!["Hello".to_string(),"World".to_string()]);

Fields

interface: ICapeArrayString

interface_ptr: *mut ICapeArrayString

Implementations

impl CapeArrayStringOutFromProvider

pub fn from<T: CapeArrayStringProviderOut>(provider: &mut T) -> Self

pub fn as_cape_array_string_out(&mut self) -> CapeArrayStringOut<'_>