the rest of the functions wrapped with macro

include/servicepoint.h

@@ -633,12 +633,6 @@ typedef struct Header {
 extern "C" {
 #endif // __cplusplus
 
-/**
- * Call this function at the beginning of main to enable rust logging controlled by the
- * `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
- */
-void init_env_logger(void);
-
 /**
  *Clones a [`Bitmap`] instance.
  *
@@ -1655,7 +1649,7 @@ void sp_cmd_clear_free(struct ClearCommand */*notnull*/ instance);
  *
  * Does not affect brightness.
  *
- * Returns: a new [ClearCommand] instance.
+ * Returns: a new [`ClearCommand`] instance.
  *
  * This function is part of the sp_cmd_clear module.
  */
@@ -1752,7 +1746,7 @@ void sp_cmd_fade_out_free(struct FadeOutCommand */*notnull*/ instance);
 /**
  * A yet-to-be-tested command.
  *
- * Returns: a new [FadeOutCommand] instance.
+ * Returns: a new [`FadeOutCommand`] instance.
  *
  * This function is part of the sp_cmd_fade_out module.
  */
@@ -1762,6 +1756,8 @@ struct FadeOutCommand */*notnull*/ sp_cmd_fade_out_new(void);
  * Clones an [SPCommand] instance.
  *
  * returns: a new [SPCommand] instance.
+ *
+ * This function is part of the sp_cmd_generic module.
  */
 struct Command sp_cmd_generic_clone(struct Command command);
 
@@ -1776,6 +1772,8 @@ struct Command sp_cmd_generic_clone(struct Command command);
  * SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new());
  * sp_command_free(c);
  * ```
+ *
+ * This function is part of the sp_cmd_generic module.
  */
 void sp_cmd_generic_free(struct Command command);
 
@@ -1784,6 +1782,8 @@ void sp_cmd_generic_free(struct Command command);
  * The [SPCommand] gets consumed.
  *
  * Returns tag [CommandTag::Invalid] in case of an error.
+ *
+ * This function is part of the sp_cmd_generic module.
  */
 struct Packet *sp_cmd_generic_into_packet(struct Command command);
 
@@ -1793,6 +1793,8 @@ struct Packet *sp_cmd_generic_into_packet(struct Command command);
  * The packet is dropped in the process.
  *
  * Returns: pointer to new [SPCommand] instance or NULL if parsing failed.
+ *
+ * This function is part of the sp_cmd_generic module.
  */
 struct Command sp_cmd_generic_try_from_packet(struct Packet */*notnull*/ packet);
 
@@ -1808,7 +1810,7 @@ void sp_cmd_hard_reset_free(struct HardResetCommand */*notnull*/ instance);
  *
  * Please do not send this in your normal program flow.
  *
- * Returns: a new [HardResetCommand] instance.
+ * Returns: a new [`HardResetCommand`] instance.
  *
  * This function is part of the sp_cmd_hard_reset module.
  */
@@ -1942,6 +1944,14 @@ void sp_cp437_grid_set(Cp437Grid */*notnull*/ instance,
  */
 size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ instance);
 
+/**
+ * Call this function at the beginning of main to enable rust logging controlled by the
+ * `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
+ *
+ * This function is part of the sp_envlogger module.
+ */
+void sp_envlogger_init(void);
+
 /**
  *Clones a [`Packet`] instance.
  *
@@ -1960,6 +1970,8 @@ void sp_packet_free(struct Packet */*notnull*/ instance);
  * Creates a raw [Packet] from parts.
  *
  * returns: new instance. Will never return null.
+ *
+ * This function is part of the sp_packet module.
  */
 struct Packet */*notnull*/ sp_packet_from_parts(struct Header header,
                                                 struct ByteSlice payload);
@@ -1972,11 +1984,14 @@ struct Packet */*notnull*/ sp_packet_from_parts(struct Header header,
 struct Header sp_packet_get_header(struct Packet */*notnull*/ instance);
 
 /**
- * Returns a pointer to the header field of the provided packet.
+ * Gets a reference to the field `header` of the [`servicepoint::Packet`].
  *
- * The returned header can be changed and will be valid for the lifetime of the packet.
+ * - The returned reference inherits the lifetime of object in which it is contained.
+ * - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
+ *
+ * This function is part of the sp_packet module.
  */
-struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ packet);
+struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ instance);
 
 /**
  * Returns a pointer to the current payload of the provided packet.
@@ -1984,6 +1999,8 @@ struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ p
  * Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload.
  *
  * The returned memory can be changed and will be valid until a new payload is set.
+ *
+ * This function is part of the sp_packet module.
  */
 struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet);
 
@@ -1993,8 +2010,10 @@ struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet);
  * # Panics
  *
  * - if the buffer is not big enough to hold header+payload.
+ *
+ * This function is part of the sp_packet module.
  */
-void sp_packet_serialize_to(struct Packet */*notnull*/ packet,
+size_t sp_packet_serialize_to(struct Packet */*notnull*/ packet,
                               struct ByteSlice buffer);
 
 /**
@@ -2009,6 +2028,8 @@ void sp_packet_set_header(struct Packet */*notnull*/ instance,
  * Sets the payload of the provided packet to the provided data.
  *
  * This makes previous payload pointers invalid.
+ *
+ * This function is part of the sp_packet module.
  */
 void sp_packet_set_payload(struct Packet */*notnull*/ packet,
                            struct ByteSlice data);
@@ -2017,6 +2038,8 @@ void sp_packet_set_payload(struct Packet */*notnull*/ packet,
  * Tries to load a [Packet] from the passed array with the specified length.
  *
  * returns: NULL in case of an error, pointer to the allocated packet otherwise
+ *
+ * This function is part of the sp_packet module.
  */
 struct Packet *sp_packet_try_load(struct ByteSlice data);
 
@@ -2024,6 +2047,8 @@ struct Packet *sp_packet_try_load(struct ByteSlice data);
  * Converts u16 into [CommandCode].
  *
  * If the provided value is not valid, false is returned and result is not changed.
+ *
+ * This function is part of the sp module.
  */
 bool sp_u16_to_command_code(uint16_t code,
                             CommandCode *result);
@@ -2047,6 +2072,8 @@ void sp_udp_free(struct UdpSocket */*notnull*/ instance);
  * if (connection != NULL)
  *     sp_udp_send_command(connection, sp_command_clear());
  * ```
+ *
+ * This function is part of the sp_udp module.
  */
 struct UdpSocket *sp_udp_open(char */*notnull*/ host);
 
@@ -2062,6 +2089,8 @@ struct UdpSocket *sp_udp_open(char */*notnull*/ host);
  * if (connection != NULL)
  *     sp_udp_send_command(connection, sp_command_clear());
  * ```
+ *
+ * This function is part of the sp_udp module.
  */
 struct UdpSocket *sp_udp_open_ipv4(uint8_t ip1,
                                    uint8_t ip2,
@@ -2081,6 +2110,8 @@ struct UdpSocket *sp_udp_open_ipv4(uint8_t ip1,
  * ```C
  * sp_udp_send_command(connection, sp_command_brightness(5));
  * ```
+ *
+ * This function is part of the sp_udp module.
  */
 bool sp_udp_send_command(struct UdpSocket */*notnull*/ connection,
                          struct Command command);
@@ -2095,6 +2126,8 @@ bool sp_udp_send_command(struct UdpSocket */*notnull*/ connection,
  * ```C
  * sp_udp_send_header(connection, sp_command_brightness(5));
  * ```
+ *
+ * This function is part of the sp_udp module.
  */
 bool sp_udp_send_header(struct UdpSocket */*notnull*/ udp_connection,
                         struct Header header);
@@ -2105,6 +2138,8 @@ bool sp_udp_send_header(struct UdpSocket */*notnull*/ udp_connection,
  * The passed `packet` gets consumed.
  *
  * returns: true in case of success
+ *
+ * This function is part of the sp_udp module.
  */
 bool sp_udp_send_packet(struct UdpSocket */*notnull*/ connection,
                         struct Packet */*notnull*/ packet);

src/commands/cc_only_commands.rs

@@ -5,39 +5,33 @@ use crate::{
 use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand};
 use std::ptr::NonNull;
 
-wrap_functions!(sp_cmd_clear;
+macro_rules! wrap_cc_only {
+    ($prefix:ident :: $typ:ident ; $(#[$meta:meta])*) => {
+        wrap_functions!($prefix;
+            $(#[$meta])*
+            ///
+            #[doc = concat!(" Returns: a new [`",stringify!($typ),"`] instance.")]
+            fn new() -> NonNull<$typ> {
+                heap_move_nonnull($typ)
+            }
+        );
+
+        wrap_free!($prefix :: $typ);
+    };
+}
+
+wrap_cc_only!(sp_cmd_clear::ClearCommand;
     /// Set all pixels to the off state.
     ///
     /// Does not affect brightness.
-    ///
-    /// Returns: a new [ClearCommand] instance.
-    fn new() -> NonNull<ClearCommand> {
-        heap_move_nonnull(ClearCommand)
-    }
 );
 
-wrap_free!(sp_cmd_clear::ClearCommand);
+wrap_cc_only!(sp_cmd_hard_reset::HardResetCommand;
-
-wrap_functions!(sp_cmd_hard_reset;
     /// Kills the udp daemon on the display, which usually results in a restart.
     ///
     /// Please do not send this in your normal program flow.
-    ///
-    /// Returns: a new [HardResetCommand] instance.
-    fn new() -> NonNull<HardResetCommand> {
-        heap_move_nonnull(HardResetCommand)
-    }
 );
 
-wrap_free!(sp_cmd_hard_reset::HardResetCommand);
+wrap_cc_only!(sp_cmd_fade_out::FadeOutCommand;
-
-wrap_functions!(sp_cmd_fade_out;
     /// A yet-to-be-tested command.
-    ///
-    /// Returns: a new [FadeOutCommand] instance.
-    fn new() -> NonNull<FadeOutCommand> {
-        heap_move_nonnull(FadeOutCommand)
-    }
 );
-
-wrap_free!(sp_cmd_fade_out::FadeOutCommand);

src/commands/generic_command.rs

@@ -1,6 +1,9 @@
-use crate::mem::{
+use crate::{
+    macros::wrap_functions,
+    mem::{
         heap_clone, heap_drop, heap_move, heap_move_nonnull, heap_move_ok,
         heap_remove,
+    },
 };
 use servicepoint::{
     BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand,
@@ -66,13 +69,14 @@ impl SPCommand {
     };
 }
 
+wrap_functions!(sp_cmd_generic;
+
     /// Tries to turn a [Packet] into a [SPCommand].
     ///
     /// The packet is dropped in the process.
     ///
     /// Returns: pointer to new [SPCommand] instance or NULL if parsing failed.
-#[no_mangle]
+    fn try_from_packet(
-pub unsafe extern "C" fn sp_cmd_generic_try_from_packet(
         packet: NonNull<Packet>,
     ) -> SPCommand {
         let packet = *unsafe { Box::from_raw(packet.as_ptr()) };
@@ -149,8 +153,7 @@ pub unsafe extern "C" fn sp_cmd_generic_try_from_packet(
     /// Clones an [SPCommand] instance.
     ///
     /// returns: a new [SPCommand] instance.
-#[no_mangle]
+    fn clone(command: SPCommand) -> SPCommand {
-pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand {
         unsafe {
             match command.tag {
                 CommandTag::Clear => SPCommand {
@@ -231,8 +234,7 @@ pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand {
     /// SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new());
     /// sp_command_free(c);
     /// ```
-#[no_mangle]
+    fn free(command: SPCommand) {
-pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) {
         unsafe {
             match command.tag {
                 CommandTag::Invalid => (),
@@ -258,8 +260,7 @@ pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) {
     /// The [SPCommand] gets consumed.
     ///
     /// Returns tag [CommandTag::Invalid] in case of an error.
-#[no_mangle]
+    fn into_packet(
-pub unsafe extern "C" fn sp_cmd_generic_into_packet(
         command: SPCommand,
     ) -> *mut Packet {
         match command.tag {
@@ -296,3 +297,5 @@ pub unsafe extern "C" fn sp_cmd_generic_into_packet(
             }
         }
     }
+
+);

src/containers/byte_slice.rs

@@ -35,7 +35,7 @@ impl ByteSlice {
         unsafe { std::slice::from_raw_parts(self.start, self.length) }
     }
 
-    pub(crate) unsafe fn as_slice_mut(&mut self) -> &mut [u8] {
+    pub(crate) unsafe fn as_slice_mut(&self) -> &mut [u8] {
         unsafe { std::slice::from_raw_parts_mut(self.start, self.length) }
     }
 

src/lib.rs

@@ -47,10 +47,13 @@ pub struct DisplayBitVec;
 
 #[cfg(feature = "env_logger")]
 mod feature_env_logger {
+    use crate::macros::wrap_functions;
+
+    wrap_functions!(sp_envlogger;
         /// Call this function at the beginning of main to enable rust logging controlled by the
         /// `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
-    #[no_mangle]
+        fn init() {
-    pub unsafe extern "C" fn init_env_logger() {
             env_logger::init();
         }
+    );
 }

src/packet.rs

@@ -1,16 +1,17 @@
 use crate::{
     containers::ByteSlice,
-    macros::{wrap_clone, wrap_fields, wrap_free},
+    macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
     mem::{heap_move_nonnull, heap_move_ok},
 };
 use servicepoint::{CommandCode, Header, Packet};
 use std::ptr::NonNull;
 
+wrap_functions!(sp_packet;
+
     /// Tries to load a [Packet] from the passed array with the specified length.
     ///
     /// returns: NULL in case of an error, pointer to the allocated packet otherwise
-#[no_mangle]
+    fn try_load(data: ByteSlice) -> *mut Packet {
-pub unsafe extern "C" fn sp_packet_try_load(data: ByteSlice) -> *mut Packet {
         let data = unsafe { data.as_slice() };
         heap_move_ok(servicepoint::Packet::try_from(data))
     }
@@ -18,11 +19,7 @@ pub unsafe extern "C" fn sp_packet_try_load(data: ByteSlice) -> *mut Packet {
     /// Creates a raw [Packet] from parts.
     ///
     /// returns: new instance. Will never return null.
-#[no_mangle]
+    fn from_parts(header: Header, payload: ByteSlice) -> NonNull<Packet> {
-pub unsafe extern "C" fn sp_packet_from_parts(
-    header: Header,
-    payload: ByteSlice,
-) -> NonNull<Packet> {
         let payload = if payload == ByteSlice::INVALID {
             None
         } else {
@@ -32,25 +29,12 @@ pub unsafe extern "C" fn sp_packet_from_parts(
         heap_move_nonnull(Packet { header, payload })
     }
 
-/// Returns a pointer to the header field of the provided packet.
-///
-/// The returned header can be changed and will be valid for the lifetime of the packet.
-#[no_mangle]
-pub unsafe extern "C" fn sp_packet_get_header_mut(
-    packet: NonNull<Packet>,
-) -> NonNull<Header> {
-    NonNull::from(unsafe { &mut (*packet.as_ptr()).header })
-}
-
     /// Returns a pointer to the current payload of the provided packet.
     ///
     /// Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload.
     ///
     /// The returned memory can be changed and will be valid until a new payload is set.
-#[no_mangle]
+    fn get_payload(packet: NonNull<Packet>) -> ByteSlice {
-pub unsafe extern "C" fn sp_packet_get_payload(
-    packet: NonNull<Packet>,
-) -> ByteSlice {
         unsafe {
             match &mut (*packet.as_ptr()).payload {
                 None => ByteSlice::INVALID,
@@ -62,11 +46,7 @@ pub unsafe extern "C" fn sp_packet_get_payload(
     /// Sets the payload of the provided packet to the provided data.
     ///
     /// This makes previous payload pointers invalid.
-#[no_mangle]
+    fn set_payload(packet: NonNull<Packet>, data: ByteSlice) {
-pub unsafe extern "C" fn sp_packet_set_payload(
-    packet: NonNull<Packet>,
-    data: ByteSlice,
-) {
         unsafe {
             (*packet.as_ptr()).payload = if data == ByteSlice::INVALID {
                 None
@@ -81,15 +61,12 @@ pub unsafe extern "C" fn sp_packet_set_payload(
     /// # Panics
     ///
     /// - if the buffer is not big enough to hold header+payload.
-#[no_mangle]
+    fn serialize_to(packet: NonNull<Packet>, buffer: ByteSlice) -> usize {
-pub unsafe extern "C" fn sp_packet_serialize_to(
-    packet: NonNull<Packet>,
-    mut buffer: ByteSlice,
-) {
         unsafe {
-        packet.as_ref().serialize_to(buffer.as_slice_mut());
+            packet.as_ref().serialize_to(buffer.as_slice_mut()).unwrap_or(0)
         }
     }
+);
 
 wrap_clone!(sp_packet::Packet);
 wrap_free!(sp_packet::Packet);
@@ -98,15 +75,17 @@ wrap_fields!(
     sp_packet::Packet;
     prop header: Header {
         get();
+        mut get();
         set(value);
     };
 );
 
+wrap_functions!(sp;
+
     /// Converts u16 into [CommandCode].
     ///
     /// If the provided value is not valid, false is returned and result is not changed.
-#[no_mangle]
+    fn u16_to_command_code(
-pub unsafe extern "C" fn sp_u16_to_command_code(
         code: u16,
         result: *mut CommandCode,
     ) -> bool {
@@ -120,3 +99,5 @@ pub unsafe extern "C" fn sp_u16_to_command_code(
             Err(_) => false,
         }
     }
+
+);

src/udp.rs

@@ -1,6 +1,6 @@
 use crate::{
     commands::{CommandTag, SPCommand},
-    macros::wrap_free,
+    macros::{wrap_free, wrap_functions},
     mem::{heap_move_ok, heap_remove},
 };
 use servicepoint::{Header, Packet, UdpSocketExt};
@@ -10,6 +10,10 @@ use std::{
     ptr::NonNull,
 };
 
+wrap_free!(sp_udp::UdpSocket);
+
+wrap_functions!(sp_udp;
+
     /// Creates a new instance of [UdpSocket].
     ///
     /// returns: NULL if connection fails, or connected instance
@@ -21,8 +25,7 @@ use std::{
     /// if (connection != NULL)
     ///     sp_udp_send_command(connection, sp_command_clear());
     /// ```
-#[no_mangle]
+    fn open(host: NonNull<c_char>) -> *mut UdpSocket {
-pub unsafe extern "C" fn sp_udp_open(host: NonNull<c_char>) -> *mut UdpSocket {
         let host = unsafe { CStr::from_ptr(host.as_ptr()) }
             .to_str()
             .expect("Bad encoding");
@@ -41,14 +44,7 @@ pub unsafe extern "C" fn sp_udp_open(host: NonNull<c_char>) -> *mut UdpSocket {
     /// if (connection != NULL)
     ///     sp_udp_send_command(connection, sp_command_clear());
     /// ```
-#[no_mangle]
+    fn open_ipv4(ip1: u8, ip2: u8, ip3: u8, ip4: u8, port: u16) -> *mut UdpSocket {
-pub unsafe extern "C" fn sp_udp_open_ipv4(
-    ip1: u8,
-    ip2: u8,
-    ip3: u8,
-    ip4: u8,
-    port: u16,
-) -> *mut UdpSocket {
         let addr = SocketAddrV4::new(Ipv4Addr::from([ip1, ip2, ip3, ip4]), port);
         heap_move_ok(UdpSocket::bind_connect(addr))
     }
@@ -58,11 +54,7 @@ pub unsafe extern "C" fn sp_udp_open_ipv4(
     /// The passed `packet` gets consumed.
     ///
     /// returns: true in case of success
-#[no_mangle]
+    fn send_packet(connection: NonNull<UdpSocket>, packet: NonNull<Packet>) -> bool {
-pub unsafe extern "C" fn sp_udp_send_packet(
-    connection: NonNull<UdpSocket>,
-    packet: NonNull<Packet>,
-) -> bool {
         let packet = unsafe { heap_remove(packet) };
         unsafe { connection.as_ref().send(&Vec::from(packet)) }.is_ok()
     }
@@ -78,11 +70,7 @@ pub unsafe extern "C" fn sp_udp_send_packet(
     /// ```C
     /// sp_udp_send_command(connection, sp_command_brightness(5));
     /// ```
-#[no_mangle]
+    fn send_command(connection: NonNull<UdpSocket>, command: SPCommand) -> bool {
-pub unsafe extern "C" fn sp_udp_send_command(
-    connection: NonNull<UdpSocket>,
-    command: SPCommand,
-) -> bool {
         unsafe {
             match command.tag {
                 CommandTag::Invalid => return false,
@@ -130,11 +118,7 @@ pub unsafe extern "C" fn sp_udp_send_command(
     /// ```C
     /// sp_udp_send_header(connection, sp_command_brightness(5));
     /// ```
-#[no_mangle]
+    fn send_header(udp_connection: NonNull<UdpSocket>, header: Header) -> bool {
-pub unsafe extern "C" fn sp_udp_send_header(
-    udp_connection: NonNull<UdpSocket>,
-    header: Header,
-) -> bool {
         let packet = Packet {
             header,
             payload: None,
@@ -144,4 +128,4 @@ pub unsafe extern "C" fn sp_udp_send_header(
             .is_ok()
     }
 
-wrap_free!(sp_udp::UdpSocket);
+);