Struct cpython::PySharedRef

source ·
pub struct PySharedRef<'a, T: 'a + ?Sized> { /* private fields */ }
Expand description

A reference to PySharedRefCell owned by a Python object.

This is a lifetime-bound reference to the PySharedRefCell data field, and will be created by the automatically generated accessor function.

impl MyType {
    fn data_name<'a>(&'a self, py: Python<'a>) -> PySharedRef<'a, T> { ... }
}

Implementations§

source§

impl<'a, T: ?Sized> PySharedRef<'a, T>

source

pub fn borrow(&self) -> Ref<'a, T>

Immutably borrows the wrapped value.

§Panics

Panics if the value is currently mutably borrowed.

source

pub fn try_borrow(&self) -> Result<Ref<'a, T>, BorrowError>

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.

source

pub fn borrow_mut(&self) -> RefMut<'a, T>

Mutably borrows the wrapped value.

Any existing leaked references will be invalidated.

§Panics

Panics if the value is currently borrowed.

source

pub fn try_borrow_mut(&self) -> Result<RefMut<'a, T>, BorrowMutError>

Mutably borrows the wrapped value, returning an error if the value is currently borrowed.

source

pub fn leak_immutable(&self) -> UnsafePyLeaked<&'static T>

Creates an immutable reference which is not bound to lifetime.

§Panics

Panics if the value is currently mutably borrowed.

source

pub fn try_leak_immutable( &self ) -> Result<UnsafePyLeaked<&'static T>, BorrowError>

Creates an immutable reference which is not bound to lifetime, returning an error if the value is currently mutably borrowed.

Auto Trait Implementations§

§

impl<'a, T> Freeze for PySharedRef<'a, T>
where T: ?Sized,

§

impl<'a, T> !RefUnwindSafe for PySharedRef<'a, T>

§

impl<'a, T> !Send for PySharedRef<'a, T>

§

impl<'a, T> !Sync for PySharedRef<'a, T>

§

impl<'a, T> Unpin for PySharedRef<'a, T>
where T: ?Sized,

§

impl<'a, T> !UnwindSafe for PySharedRef<'a, T>

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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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.