pyo3_macros_backend::pyfunction::signature

Struct FunctionSignature

Source
pub struct FunctionSignature<'a> {
    pub arguments: Vec<FnArg<'a>>,
    pub python_signature: PythonSignature,
    pub attribute: Option<KeywordAttribute<signature, Signature>>,
}

Fields§

§arguments: Vec<FnArg<'a>>§python_signature: PythonSignature§attribute: Option<KeywordAttribute<signature, Signature>>

Implementations§

Source§

impl<'a> FunctionSignature<'a>

Source

pub fn from_arguments_and_attribute( arguments: Vec<FnArg<'a>>, attribute: KeywordAttribute<signature, Signature>, ) -> Result<Self>

Source

pub fn from_arguments(arguments: Vec<FnArg<'a>>) -> Result<Self>

Without #[pyo3(signature)] or #[args] - just take the Rust function arguments as positional.

Source

fn default_value_for_parameter(&self, parameter: &str) -> String

Source

pub fn text_signature(&self, self_argument: Option<&str>) -> String

Auto Trait Implementations§

§

impl<'a> Freeze for FunctionSignature<'a>

§

impl<'a> RefUnwindSafe for FunctionSignature<'a>

§

impl<'a> !Send for FunctionSignature<'a>

§

impl<'a> !Sync for FunctionSignature<'a>

§

impl<'a> Unpin for FunctionSignature<'a>

§

impl<'a> UnwindSafe for FunctionSignature<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)] const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here