278a1379e2
The previous "See underlying function" text didn't provide a way to find the underlying function, forcing users to search the codebase. Stating the safety contracts explicitly makes the API usable.
26 lines
870 B
Rust
26 lines
870 B
Rust
//! Functions that are relevant for other bindings modules, but normally not end users.
|
|
use super::Value;
|
|
use nix_bindings_bindgen_raw as raw;
|
|
|
|
/// Take ownership of a new [`Value`].
|
|
///
|
|
/// This does not call `nix_gc_incref`, but does call `nix_gc_decref` when dropped.
|
|
///
|
|
/// # Safety
|
|
///
|
|
/// The caller must ensure that the provided `ptr` has a positive reference count,
|
|
/// and that `ptr` is not used after the returned `Value` is dropped.
|
|
pub unsafe fn raw_value_new(ptr: *mut raw::Value) -> Value {
|
|
Value::new(ptr)
|
|
}
|
|
|
|
/// Borrow a reference to a [`Value`].
|
|
///
|
|
/// This calls `value_incref`, and the returned Value will call `value_decref` when dropped.
|
|
///
|
|
/// # Safety
|
|
///
|
|
/// The caller must ensure that the provided `ptr` has a positive reference count.
|
|
pub unsafe fn raw_value_new_borrowed(ptr: *mut raw::Value) -> Value {
|
|
Value::new_borrowed(ptr)
|
|
}
|