magenta 0.2.0

Rust bindings for the Magenta kernel
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
41
42

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

//! Type-safe bindings for Magenta event objects.

use {AsHandleRef, Cookied, HandleBased, Handle, HandleRef, Status};
use {sys, into_result};

/// An object representing a Magenta
/// [event object](https://fuchsia.googlesource.com/magenta/+/master/docs/objects/event.md).
///
/// As essentially a subtype of `Handle`, it can be freely interconverted.
#[derive(Debug, Eq, PartialEq)]
pub struct Event(Handle);
impl_handle_based!(Event);
impl Cookied for Event {}

impl Event {
    /// Create an event object, an object which is signalable but nothing else. Wraps the
    /// [mx_event_create](https://fuchsia.googlesource.com/magenta/+/master/docs/syscalls/event_create.md)
    /// syscall.
    pub fn create(options: EventOpts) -> Result<Event, Status> {
        let mut out = 0;
        let status = unsafe { sys::mx_event_create(options as u32, &mut out) };
        into_result(status, || Self::from(Handle(out)))
    }
}

/// Options for creating an event object.
#[repr(u32)]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum EventOpts {
    /// Default options.
    Default = 0,
}

impl Default for EventOpts {
    fn default() -> Self {
        EventOpts::Default
    }
}