summaryrefslogtreecommitdiffhomepage
path: root/docs/carc_api.md
diff options
context:
space:
mode:
authorTyge Lovset <[email protected]>2022-08-12 11:38:10 +0200
committerTyge Lovset <[email protected]>2022-08-12 11:38:10 +0200
commita417e5affc99233abb6dbb685154bfdea1b726e3 (patch)
tree211f1e1c000d57ea7e5ca318c625996ce094dc76 /docs/carc_api.md
parentf534db7ac4a993a05074868b8840a3a674ac76b4 (diff)
downloadSTC-modified-a417e5affc99233abb6dbb685154bfdea1b726e3.tar.gz
STC-modified-a417e5affc99233abb6dbb685154bfdea1b726e3.zip
More misc changes carc/cbox, cdeq/cvec.
Diffstat (limited to 'docs/carc_api.md')
-rw-r--r--docs/carc_api.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/carc_api.md b/docs/carc_api.md
index 8061c642..d09b1839 100644
--- a/docs/carc_api.md
+++ b/docs/carc_api.md
@@ -32,17 +32,17 @@ See similar c++ class [std::shared_ptr](https://en.cppreference.com/w/cpp/memory
## Methods
```c
carc_X carc_X_init(); // empty shared pointer
-carc_X carc_X_new(i_valraw raw); // construct a new value in an carc from raw type.
-carc_X carc_X_from(i_val val); // create a carc from constructed val object. Faster than from_ptr().
-carc_X carc_X_from_ptr(i_val* p); // create a carc from raw pointer. Takes ownership of p.
+carc_X carc_X_new(i_valraw raw); // create an carc from raw type (available if i_valraw defined by user).
+carc_X carc_X_from(i_val val); // create an carc from constructed val object. Faster than from_ptr().
+carc_X carc_X_from_ptr(i_val* p); // create an carc from raw pointer. Takes ownership of p.
carc_X carc_X_clone(carc_X other); // return other with increased use count
carc_X carc_X_move(carc_X* self); // transfer ownership to another carc.
void carc_X_take(carc_X* self, carc_X other); // take ownership of other.
-void carc_X_assign(carc_X* self, carc_X other); // copy shared (increase use count)
+void carc_X_copy(carc_X* self, carc_X other); // shared assign (increase use count)
void carc_X_drop(carc_X* self); // destruct (decrease use count, free at 0)
-long carc_X_use_count(carc_X ptr);
+long carc_X_use_count(const carc_X* self);
void carc_X_reset(carc_X* self);
void carc_X_reset_to(carc_X* self, i_val* p); // assign new carc from ptr. Takes ownership of p.