zx/
event.rs

1// Copyright 2017 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5//! Type-safe bindings for Zircon event objects.
6
7use crate::{ok, AsHandleRef, Handle, HandleBased, HandleRef};
8
9/// An object representing a Zircon
10/// [event object](https://fuchsia.dev/fuchsia-src/concepts/objects/event.md).
11///
12/// As essentially a subtype of `Handle`, it can be freely interconverted.
13#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
14#[repr(transparent)]
15pub struct Event(Handle);
16impl_handle_based!(Event);
17
18impl Event {
19    /// Create an event object, an object which is signalable but nothing else. Wraps the
20    /// [zx_event_create](https://fuchsia.dev/fuchsia-src/reference/syscalls/event_create.md)
21    /// syscall.
22    ///
23    /// # Panics
24    ///
25    /// If the kernel reports no memory available or the process' job policy denies event creation.
26    pub fn create() -> Self {
27        let mut out = 0;
28        let opts = 0;
29        let status = unsafe { crate::sys::zx_event_create(opts, &mut out) };
30        ok(status)
31            .expect("event creation always succeeds except with OOM or when job policy denies it");
32        unsafe { Self::from(Handle::from_raw(out)) }
33    }
34}
zx/event.rs

zx/
event.rs
