Function pact_ffi::models::message::pactffi_message_get_provider_state

source · 
#[no_mangle]
pub extern "C" fn pactffi_message_get_provider_state(
    message: *const Message,
    index: c_uint
) -> *const ProviderState
Expand description

Get a copy of the provider state at the given index from this message.

§Safety

The returned structure must be deleted with provider_state_delete.

Since it is a copy, the returned structure may safely outlive the Message.

§Error Handling

On failure, this function will return a variant other than Success.

This function may fail if the index requested is out of bounds, or if any of the Rust strings contain embedded null (‘\0’) bytes.