# print_serial.rs - source
Source of the Rust file `arduboy-rust\src\print_serial.rs`.

    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
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178

    //! This is the Module to interact in a save way with the Arduino Serial C++ library.

    use crate::prelude::Pstring;
    use core::ffi::{c_char, c_int, c_long, c_size_t, c_uchar, c_uint, c_ulong};

    #[derive(Debug, Copy, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
    pub enum Base {
        Bin = 2,
        Oct = 8,
        Dec = 10,
        Hex = 16,
    }

    extern "C" {
        #[link_name = "arduino_serial_begin"]
        fn serial_begin(serial: c_ulong);
        #[link_name = "arduino_serial_println_chars"]
        fn print_chars(cstr: *const c_char);
        #[doc(hidden)]
        #[link_name = "arduino_serial_println_chars_progmem"]
        fn print_chars_progmem(pstring: *const c_char);
        // #[link_name = "arduino_serial_print_char"]
        // fn print_char(c: c_char) -> c_size_t;
        #[doc(hidden)]
        #[link_name = "arduino_serial_print_int"]
        fn print_int(n: c_int, base: c_int) -> c_size_t;
        #[doc(hidden)]
        #[link_name = "arduino_serial_print_long"]
        fn print_long(n: c_long, base: c_int) -> c_size_t;
        #[doc(hidden)]
        #[link_name = "arduino_serial_print_unsigned_char"]
        fn print_unsigned_char(n: c_uchar, base: c_int) -> c_size_t;
        #[doc(hidden)]
        #[link_name = "arduino_serial_print_unsigned_int"]
        fn print_unsigned_int(n: c_uint, base: c_int) -> c_size_t;
        #[doc(hidden)]
        #[link_name = "arduino_serial_print_unsigned_long"]
        fn print_unsigned_long(n: c_ulong, base: c_int) -> c_size_t;
    }
    ///The Arduino Serial Print class is available for writing text to the screen buffer.
    ///
    ///In the same manner as the Arduino arduboy.print(), etc., functions.
    ///
    ///
    ///Example
    /// ```
    /// let value: i16 = 42;
    ///
    /// serial.print(b"Hello World\n\0"[..]); // Prints "Hello World" and then sets the
    ///                                       // text cursor to the start of the next line
    /// serial.print(f!(b"Hello World\n")); // Prints "Hello World" but does not use the 2kb ram
    /// serial.print(value); // Prints "42"
    /// serial.print("\n\0"); // Sets the text cursor to the start of the next line
    /// serial.print("hello world") // Prints normal [&str]
    /// ```
    pub fn print(x: impl Printable) {
        x.print()
    }
    /// Set the Baud rate for the serial monitor
    pub fn begin(baud_rates: u32) {
        unsafe { serial_begin(baud_rates) }
    }
    pub trait Printable
    where
        Self: Sized,
    {
        type Parameters;

        fn print_2(self, params: Self::Parameters);
        fn default_parameters() -> Self::Parameters;

        fn print(self) {
            self.print_2(Self::default_parameters());
        }
    }

    impl Printable for i16 {
        type Parameters = Base;

        fn print_2(self, params: Self::Parameters) {
            unsafe {
                print_int(self, params as c_int);
            }
        }

        fn default_parameters() -> Self::Parameters {
            Base::Dec
        }
    }

    impl Printable for u16 {
        type Parameters = Base;

        fn print_2(self, params: Self::Parameters) {
            unsafe {
                print_unsigned_int(self, params as c_int);
            }
        }

        fn default_parameters() -> Self::Parameters {
            Base::Dec
        }
    }

    impl Printable for i32 {
        type Parameters = Base;

        fn print_2(self, params: Self::Parameters) {
            unsafe {
                print_long(self, params as c_int);
            }
        }

        fn default_parameters() -> Self::Parameters {
            Base::Dec
        }
    }

    impl Printable for u32 {
        type Parameters = Base;

        fn print_2(self, params: Self::Parameters) {
            unsafe {
                print_unsigned_long(self, params as c_int);
            }
        }

        fn default_parameters() -> Self::Parameters {
            Base::Dec
        }
    }

    impl Printable for &[u8] {
        type Parameters = ();

        fn print_2(self, _params: Self::Parameters) {
            unsafe {
                print_chars(self as *const [u8] as *const i8);
            }
        }

        fn default_parameters() -> Self::Parameters {}
    }

    impl Printable for &str {
        type Parameters = ();

        fn print_2(self, _params: Self::Parameters) {
            unsafe {
                print_chars(self.as_bytes() as *const [u8] as *const i8);
            }
        }

        fn default_parameters() -> Self::Parameters {}
    }
    impl<const N: usize> Printable for crate::heapless::String<N> {
        type Parameters = ();

        fn print_2(self, _params: Self::Parameters) {
            unsafe {
                print_chars(self.as_bytes() as *const [u8] as *const i8);
            }
        }

        fn default_parameters() -> Self::Parameters {}
    }

    impl Printable for Pstring {
        type Parameters = ();

        fn print_2(self, _params: Self::Parameters) {
            unsafe {
                print_chars_progmem(self.pointer);
            }
        }

        fn default_parameters() -> Self::Parameters {}
    }