Skip to content

Commit

Permalink
docs: Update comment for pactffi_message_given_with_param
Browse files Browse the repository at this point in the history
  • Loading branch information
tienvx committed Oct 31, 2024
1 parent a85d9e0 commit 82e570a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions rust/pact_ffi/src/mock_server/handles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2795,11 +2795,14 @@ pub extern fn pactffi_message_given(message: MessageHandle, description: *const
}
}

/// Adds a provider state to the Message with a parameter key and value.
/// Adds a parameter key and value to a provider state to the Message. If the provider state
/// does not exist, a new one will be created, otherwise the parameter will be merged into the
/// existing one. The parameter value will be parsed as JSON.
///
/// # Parameters
/// * `description` - The provider state description. It needs to be unique.
/// * `name` - Parameter name.
/// * `value` - Parameter value.
/// * `value` - Parameter value as JSON.
#[no_mangle]
pub extern fn pactffi_message_given_with_param(message: MessageHandle, description: *const c_char,
name: *const c_char, value: *const c_char) {
Expand Down

0 comments on commit 82e570a

Please sign in to comment.