Docs.rs
  • rb-sys-0.9.87
    • rb-sys 0.9.87
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • matsadler
    • ianks
    • Dependencies
      • rusty-fork ^0.3.0 dev
      • rb-sys-build ^0.9.87 build
    • Versions
    • 70.74% of the crate is documented
  • Go to latest version
  • Platform
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Badges
    • Builds
    • Metadata
    • Shorthand URLs
    • Download
    • Rustdoc JSON
    • Build queue
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

rb_sys0.9.87

In rb_sys::bindings::uncategorized

?
Change settings

Function rb_sys::bindings::uncategorized::ruby_xfree

source ·
pub unsafe extern "C" fn ruby_xfree(ptr: *mut c_void)
Expand description

Deallocates a storage instance.

@param[out] ptr Either NULL, or a valid pointer previously returned from one of ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(), ruby_xrealloc(), or ruby_xrealloc2(). @warning Every single storage instance that was previously allocated by either ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(), ruby_xrealloc(), or ruby_xrealloc2() shall be invalidated exactly once by either passing it to ruby_xfree(), or passing it to either ruby_xrealloc(), ruby_xrealloc2() then check the return value for invalidation. @warning Do not pass anything other than pointers described above. For instance pointers returned from malloc() or mmap() shall not be passed to this function, because the underlying memory management mechanism could differ. @warning Do not pass any invalid pointers to this function e.g. by calling it twice with a same argument.

Generated by rb-sys for Ruby 3.0.2