Struct CapsuleName 

pub struct CapsuleName { /* private fields */ }

The name given to a capsule object.

This is a thin wrapper around *const c_char, which can be accessed with the as_ptr method. The as_cstr method can be used as a convenience to access the name as a &CStr.

There is no guarantee that this capsule name pointer valid for any length of time, as arbitrary Python code may change the name of a capsule object (by reaching native code which calls PyCapsule_SetName). See the safety notes on as_cstr.

Implementations

impl CapsuleName

pub unsafe fn as_cstr<'a>(self) -> &'a CStr

Returns the capsule name as a &CStr.

Note: this method is a thin wrapper around CStr::from_ptr so (as of Rust 1.91) incurs a length calculation on each call.

Safety

There is no guarantee that the capsule name remains valid for any length of time, as arbitrary Python code may change the name of the capsule. The caller should be aware of any conventions of the capsule in question related to the lifetime of the name (many capsule names are statically allocated, i.e. have the 'static lifetime, but Python does not require this).

The returned lifetime 'a is not related to the lifetime of the capsule itself, and the caller is responsible for using the &CStr for as short a time as possible.

pub fn as_ptr(self) -> *const c_char

Returns the raw pointer to the capsule name.

Trait Implementations

impl Clone for CapsuleName

fn clone(&self) -> CapsuleName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CapsuleName