src/common/ringbuf.rs

   1 /*
   2  * Copyright (c) 2019 Tilman Sauerbeck (tilman at code-monkey de)
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 pub enum Ringbuf {
  25 }
  26
  27 extern {
  28     fn ringbuf_is_empty(ringbuf: *const Ringbuf) -> bool;
  29     fn ringbuf_is_full(ringbuf: *const Ringbuf) -> bool;
  30     fn ringbuf_write(ringbuf: *mut Ringbuf, value: u8);
  31     fn ringbuf_read(ringbuf: *const Ringbuf) -> u8;
  32 }
  33
  34 impl Ringbuf {
  35     pub fn is_empty(&self) -> bool {
  36         unsafe { ringbuf_is_empty(self) }
  37     }
  38
  39     pub fn is_full(&self) -> bool {
  40         unsafe { ringbuf_is_full(self) }
  41     }
  42
  43     pub fn write(&mut self, value: u8) {
  44         unsafe { ringbuf_write(self, value) }
  45     }
  46
  47     pub fn read(&self) -> u8 {
  48         unsafe { ringbuf_read(self) }
  49     }
  50 }