luxolus/pyo3
2
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #968 from PyO3/davidhewitt-patch-3

Browse source 
Tidy up docs for from_borrowed_ptr methods
This commit is contained in:
Yuji Kanagawa 2020-06-09 19:25:16 +09:00 committed by GitHub
parent f19e39ab40 bd7869002f
commit 4317f16a99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/python.rs
View file

@ -404,10 +404,9 @@ impl<'p> Python<'p> {
FromPyPointer::from_owned_ptr_or_opt(self, ptr)
}
/// Registers the borrowed object pointer in the release pool.
/// Does an unchecked downcast to the specific type.
///
/// Panics if the pointer is NULL.
/// Does an unchecked downcast to the specific type.
#[allow(clippy::wrong_self_convention)]
pub unsafe fn from_borrowed_ptr<T>(self, ptr: *mut ffi::PyObject) -> &'p T
where
@ -416,10 +415,9 @@ impl<'p> Python<'p> {
FromPyPointer::from_borrowed_ptr(self, ptr)
}
/// Registers the borrowed object pointer in the release pool.
/// Does an unchecked downcast to the specific type.
///
/// Returns `Err(PyErr)` if the pointer is NULL.
/// Does an unchecked downcast to the specific type.
#[allow(clippy::wrong_self_convention)]
pub unsafe fn from_borrowed_ptr_or_err<T>(self, ptr: *mut ffi::PyObject) -> PyResult<&'p T>
where
@ -428,10 +426,9 @@ impl<'p> Python<'p> {
FromPyPointer::from_borrowed_ptr_or_err(self, ptr)
}
/// Registers the borrowed object pointer in the release pool.
/// Does an unchecked downcast to the specific type.
///
/// Returns `None` if the pointer is NULL.
/// Does an unchecked downcast to the specific type.
#[allow(clippy::wrong_self_convention)]
pub unsafe fn from_borrowed_ptr_or_opt<T>(self, ptr: *mut ffi::PyObject) -> Option<&'p T>
where