Struct FunctionDeclaration 

pub struct FunctionDeclaration {
    pub name: String,
    pub description: String,
    pub behavior: Option<Behavior>,
    pub parameters: Option<Schema>,
    pub parameters_json_schema: Option<Value>,
    pub response: Option<Schema>,
    pub response_json_schema: Option<Value>,
}

Fields

name: String

description: String

behavior: Option<Behavior>

parameters: Option<Schema>

parameters_json_schema: Option<Value>

response: Option<Schema>

response_json_schema: Option<Value>

Trait Implementations

impl Clone for FunctionDeclaration

fn clone(&self) -> FunctionDeclaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDeclaration

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

Formats the value using the given formatter.

impl Default for FunctionDeclaration

fn default() -> FunctionDeclaration

Returns the “default value” for a type.

impl DerefToPyAny for FunctionDeclaration

impl<'de> Deserialize<'de> for FunctionDeclaration

where FunctionDeclaration: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<FunctionDeclaration, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for FunctionDeclaration

where FunctionDeclaration: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<FunctionDeclaration, <FunctionDeclaration as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for FunctionDeclaration

type Target = FunctionDeclaration

The Python output type

type Output = Bound<'py, <FunctionDeclaration as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<FunctionDeclaration as IntoPyObject<'py>>::Output, <FunctionDeclaration as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PartialEq for FunctionDeclaration

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for FunctionDeclaration

const NAME: &'static str = "FunctionDeclaration"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for FunctionDeclaration

const NAME: &'static str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for FunctionDeclaration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionDeclaration