Struct BorrowedPointer

pub struct BorrowedPointer<'a, P, T: 'a> { /* private fields */ }

A pointer whose contents were borrowed from a Rust object, and therefore whose lifetime is limited to the lifetime of the underlying Rust object. The Rust object was borrowed from a shared reference, and therefore the pointer is not mutable.

Implementations

impl<'a, P, T: 'a> BorrowedPointer<'a, P, T>

pub unsafe fn new(ptr: *const P, storage: T) -> Self

Return a new BorrowedPointer that wraps the pointer ptr. storage can contain any other data that ptr points to, and that should be dropped when the BorrowedPointer goes out of scope.

Safety

The pointer must be valid for the lifetime of the BorrowedPointer. If the pointer points into the storage, T must be pinned.

pub fn as_ptr(&self) -> *const P

Return the pointer that is stored in the BorrowedPointer. The pointer is valid for as long as the BorrowedPointer itself.

let s = CString::new("Hello, world!").unwrap();
let borrowed = s.borrow_foreign();
let len = unsafe { libc::strlen(borrowed.as_ptr()) };

impl<'a, T: CloneToForeign + ?Sized + 'a> BorrowedPointer<'a, T::Foreign, &T>

pub fn to_owned(&self) -> OwnedPointer<T>

Clone the underlying data for the receiver, creating a new C datum that contains the same data.

let s = CString::new("Hello, world!").unwrap();
assert_eq!(s.borrow_foreign().as_ptr(), s.as_ptr());
assert_ne!(s.borrow_foreign().to_owned().as_ptr(), s.as_ptr());

let s: i8 = 42;
assert_eq!(s.borrow_foreign().as_ptr(), &s as *const _);
assert_ne!(s.borrow_foreign().to_owned().as_ptr(), &s as *const _);

Trait Implementations

impl<'a, P, T: 'a> Debug for BorrowedPointer<'a, P, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.