pyo3::types::float

Struct PyFloat

Source 
#[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§

impl PyFloat

Source

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

Source§

impl PyFloat

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<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> 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)
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<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