cry/nixide
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

maint: Use /// for doc comments

Browse source 
(cherry picked from commit 4a390197f71653dda99696ed5c9cbca8c6a95a4b)
This commit is contained in:
Robert Hensing 2024-05-24 11:15:43 +02:00
parent ffdbf49ec5
commit 37da6411d0
3 changed files with 10 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

18
rust/nix-store/src/path.rs
View file

@ -9,20 +9,16 @@ pub struct StorePath {
raw: *mut raw::StorePath,
}
impl StorePath {
/**
* This is a low level function that you shouldn't have to call unless you are developing the Nix bindings.
*
* Construct a new `StorePath` by first cloning the C store path.
* This does not take ownership of the C store path, so it should be a borrowed value, or you should free it.
*/
/// This is a low level function that you shouldn't have to call unless you are developing the Nix bindings.
///
/// Construct a new `StorePath` by first cloning the C store path.
/// This does not take ownership of the C store path, so it should be a borrowed value, or you should free it.
pub fn new_raw_clone(raw: *const raw::StorePath) -> Self {
Self::new_raw(unsafe { raw::store_path_clone(raw as *mut raw::StorePath) })
}
/**
* This is a low level function that you shouldn't have to call unless you are developing the Nix bindings.
*
* Takes ownership of a C `nix_store_path`. It will be freed when the `StorePath` is dropped.
*/
/// This is a low level function that you shouldn't have to call unless you are developing the Nix bindings.
///
/// Takes ownership of a C `nix_store_path`. It will be freed when the `StorePath` is dropped.
pub fn new_raw(raw: *mut raw::StorePath) -> Self {
StorePath { raw }
}