pyo3::types::float

Struct PyFloat

#[repr(transparent)]
pub struct PyFloat(PyAny);

Expand description

Represents a Python float object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyFloat> or Bound<'py, PyFloat>.

For APIs available on float objects, see the PyFloatMethods trait which is implemented for Bound<'py, PyFloat>.

You can usually avoid directly working with this type by using ToPyObject and extract with f32/f64.

Tuple Fields§

§0: PyAny

Implementations§

Source §

pub fn new(py: Python<'_>, val: c_double) -> Bound<'_, PyFloat>

Creates a new Python float object.

Source

pub fn new_bound(py: Python<'_>, val: c_double) -> Bound<'_, PyFloat>

👎Deprecated since 0.23.0: renamed to PyFloat::new

Deprecated name for PyFloat::new.

Methods from Deref<Target = PyAny>§

Source

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations§

Source §

impl AsRef<PyAny> for PyFloat

Source §

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl Deref for PyFloat

Source §

type Target = PyAny

The resulting type after dereferencing.

Source §

fn deref(&self) -> &PyAny

Dereferences the value.

Source §

impl PyClassBaseType for PyFloat

Available on non-Py_LIMITED_API only.

Source §

type LayoutAsBase = PyClassObjectBase<PyFloatObject>

Source §

type BaseNativeType = PyFloat

Source §

type Initializer = PyNativeTypeInitializer<PyFloat>

Source §

type PyClassMutability = ImmutableClass

Source §

impl PyTypeInfo for PyFloat

Source §

const NAME: &'static str = "PyFloat"

Class name.

Source §

const MODULE: Option<&'static str> = _

Module name, if any.

Source §

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

Returns the PyTypeObject instance for this type.

Source §

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

Source §

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

Returns the safe abstraction over the type object.

Source §

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

Source §

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

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

Source §

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

Checks if object is an instance of this type.

Source §

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

Source §

impl DerefToPyAny for PyFloat

Source §

impl PyLayout<PyFloat> for PyFloatObject

Source §

impl PySizedLayout<PyFloat> for PyFloatObject

Auto Trait Implementations§

§

impl !Freeze for PyFloat

§

impl !RefUnwindSafe for PyFloat

§

impl !Send for PyFloat

§

impl !Sync for PyFloat

§

impl Unpin for PyFloat

§

impl UnwindSafe for PyFloat

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> AssertNotZeroSized for T

Source §

const _CONDITION: usize = _

Source §

const _CHECK: &'static str = _

Source §

fn assert_not_zero_sized(&self)

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source §

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.

Source §

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

Checks if object is an instance of Self, which may include a subtype. Read more

Source §

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source §

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

Available on non-bootstrap only.

The target type on which the method may be called.

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> SomeWrap<T> for T

Source §

fn wrap(self) -> Option<T>

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Struct PyFloatCopy item path

Tuple Fields§

Implementations§

impl PyFloat

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyFloat

pub fn new(py: Python<'_>, val: c_double) -> Bound<'_, PyFloat>

pub fn new_bound(py: Python<'_>, val: c_double) -> Bound<'_, PyFloat>

Methods from Deref<Target = PyAny>§

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations§

impl AsRef<PyAny> for PyFloat

fn as_ref(&self) -> &PyAny

impl Deref for PyFloat

type Target = PyAny

fn deref(&self) -> &PyAny

impl PyClassBaseType for PyFloat

type LayoutAsBase = PyClassObjectBase<PyFloatObject>

type BaseNativeType = PyFloat

type Initializer = PyNativeTypeInitializer<PyFloat>

type PyClassMutability = ImmutableClass

impl PyTypeInfo for PyFloat

const NAME: &'static str = "PyFloat"

const MODULE: Option<&'static str> = _

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

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

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

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

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

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

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

impl DerefToPyAny for PyFloat

impl PyLayout<PyFloat> for PyFloatObject

impl PySizedLayout<PyFloat> for PyFloatObject

Auto Trait Implementations§

impl !Freeze for PyFloat

impl !RefUnwindSafe for PyFloat

impl !Send for PyFloat

impl !Sync for PyFloat

impl Unpin for PyFloat

impl UnwindSafe for PyFloat

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> AssertNotZeroSized for T

const _CONDITION: usize = _

const _CHECK: &'static str = _

fn assert_not_zero_sized(&self)

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> PyTypeCheck for Twhere T: PyTypeInfo,

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

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

impl<P, T> Receiver for Pwhere P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

impl<T> SizedTypeProperties for T

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

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

impl<T> SomeWrap<T> for T

fn wrap(self) -> Option<T>

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

type Error = Infallible

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

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

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

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

Struct PyFloat

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

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

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

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

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

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