Struct MetadataSegment

pub struct MetadataSegment(/* private fields */);

metadata segment object.

Implementations

impl MetadataSegment

pub fn get_metadata_as_xml(&self) -> Result<MetadataAsXml>

Get the XML-metadata information from the specified metadata-segment object. Note that the XML-metadata is returned as a pointer to the data (in the ‘data’ field of the ‘MetadataAsXmlInterop’ structure), which must be freed by the caller using ‘libCZI_Free’.

\param metadata_segment_object The metadata segment object. \param [out] metadata_as_xml_interop If successful, the XML-metadata information is put here.

\returns An error-code indicating success or failure of the operation.

pub fn get_czi_document_info(&self) -> Result<CziDocumentInfo>

Create a CZI-document-information object from the specified metadata-segment object.

\param metadata_segment_object The metadata segment object. \param [in,out] czi_document_info If successful, a handle to the newly created CZI-document-info object is put here.

\returns An error-code indicating success or failure of the operation.

pub fn release(&self) -> Result<()>

Release the specified metadata-segment object.

\param metadata_segment_object The metadata-segment object to be released.

\returns An error-code indicating success or failure of the operation.

Trait Implementations

impl Clone for MetadataSegment

fn clone(&self) -> MetadataSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataSegment

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

Formats the value using the given formatter.

impl Deref for MetadataSegment

type Target = i64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for MetadataSegment

fn drop(&mut self)

Executes the destructor for this type.