Struct CapeArrayByteOutFromProvider

pub struct CapeArrayByteOutFromProvider {
    interface: ICapeArrayByte,
    interface_ptr: *mut ICapeArrayByte,
}

CapeArrayByteOutFromProvider

When calling a CAPE-OPEN method that takes a CapeArrayByte as output, the caller provides an object that implements CapeArrayByteProviderOut, for example CapeArrayByteVec.

The CapeArrayByteOutFromProvider returns an C::ICapeArrayByte 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::CapePersistReader.

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

Typically a function call receives the C::ICapeArrayByte interface from the caller, and from this, the CapeArrayByteOut 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 CapeArrayByteProviderOut trait, allocate the pointer, point to it, and construct the CapeArrayByteOut object from a reference to that pointer.

The CapeArrayByteOutFromProvider class does all this.

Example

use cobia::*;
let mut array = CapeArrayByteVec::new();
fn SetArrayOut(array:&mut CapeArrayByteOut) {
    array.put_array(&[1,2,3]);
}
SetArrayOut(&mut CapeArrayByteOutFromProvider::from(&mut array).as_cape_array_byte_out()); //this is how array is passed as &mut CapeArrayByteOut argument
assert_eq!(array.as_vec(),&vec![1,2,3]);

Fields

interface: ICapeArrayByte

interface_ptr: *mut ICapeArrayByte

Implementations

impl CapeArrayByteOutFromProvider

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

pub fn as_cape_array_byte_out(&mut self) -> CapeArrayByteOut<'_>