hexavalent 0.3.0

Write HexChat plugins in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! This module exists solely to provide exports for the `hexchat_plugin` macro to use.
//!
//! DO NOT IMPORT OR USE ANYTHING FROM THIS MODULE

use std::os::raw::c_int;

use crate::plugin::Plugin;
use crate::state;

/// UNSTABLE: do not use this type.
///
/// Used by the `hexchat_plugin` macro.
#[doc(hidden)]
pub use crate::ffi::hexchat_plugin;

/// UNSTABLE: do not call this function.
///
/// Used by the `hexchat_plugin` macro.
///
/// # Safety
///
/// `plugin_handle` must point to a valid `hexchat_plugin`.
#[doc(hidden)]
pub unsafe fn hexchat_plugin_init<P: Plugin>(plugin_handle: *mut hexchat_plugin) -> c_int {
    // Safety: safety requirement forwarded to caller
    unsafe { state::hexchat_plugin_init::<P>(plugin_handle) }
}

/// UNSTABLE: do not call this function.
///
/// Used by the `hexchat_plugin` macro.
///
/// # Safety
///
/// `plugin_handle` must point to a valid `hexchat_plugin`.
#[doc(hidden)]
pub unsafe fn hexchat_plugin_deinit<P: Plugin>(plugin_handle: *mut hexchat_plugin) -> c_int {
    // Safety: safety requirement forwarded to caller
    unsafe { state::hexchat_plugin_deinit::<P>(plugin_handle) }
}