Struct FunctionCall 

pub struct FunctionCall { /* private fields */ }

Validated client function call requested by a model.

Examples

use providers_kit::generation::FunctionCall;
let call = FunctionCall::new(Some("call-1".into()), "lookup", serde_json::json!({"key":"a"}))?;
assert_eq!(call.id(), Some("call-1"));
assert_eq!(call.name(), "lookup");
assert_eq!(call.arguments()["key"], "a");

Implementations

impl FunctionCall

pub fn new( id: Option<String>, name: impl Into<String>, arguments: Value, ) -> Result<Self, KitError>

Creates a validated function call.

Errors

Returns an input error for an invalid portable function name, invalid optional call id, or arguments that are not a JSON object. Keep returned call correlation unchanged in its result.

Examples

use providers_kit::generation::FunctionCall;
let call = FunctionCall::new(Some("call-1".into()), "lookup", serde_json::json!({"key":"a"}))?;
assert_eq!(call.id(), Some("call-1"));
assert_eq!(call.name(), "lookup");
assert_eq!(call.arguments()["key"], "a");

pub fn id(&self) -> Option<&str>

Returns the provider correlation id, when one was supplied.

Examples

use providers_kit::generation::FunctionCall;
let call = FunctionCall::new(Some("call-1".into()), "lookup", serde_json::json!({"key":"a"}))?;
assert_eq!(call.id(), Some("call-1"));
assert_eq!(call.name(), "lookup");
assert_eq!(call.arguments()["key"], "a");

pub fn name(&self) -> &str

Returns the function name.

Examples

use providers_kit::generation::FunctionCall;
let call = FunctionCall::new(Some("call-1".into()), "lookup", serde_json::json!({"key":"a"}))?;
assert_eq!(call.id(), Some("call-1"));
assert_eq!(call.name(), "lookup");
assert_eq!(call.arguments()["key"], "a");

pub fn arguments(&self) -> &Value

Returns the validated object-shaped arguments.

Examples

use providers_kit::generation::FunctionCall;
let call = FunctionCall::new(Some("call-1".into()), "lookup", serde_json::json!({"key":"a"}))?;
assert_eq!(call.id(), Some("call-1"));
assert_eq!(call.name(), "lookup");
assert_eq!(call.arguments()["key"], "a");

Trait Implementations

impl Clone for FunctionCall

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionCall

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionCall

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionCall

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for FunctionCall

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionCall