carnelian/
lib.rs

1// Copyright 2018 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//! Carnelian
6//!
7//! Carnelian is a prototype framework for writing
8//! [Fuchsia](https://fuchsia.dev/fuchsia-src/concepts)
9//! applications in
10//! [Rust](https://www.rust-lang.org/).
11//!
12//! Below is a tiny example of a Carnelian app.
13//!
14//! The [`ViewAssistant`] trait is a good place to start when learning
15//! about Carnelian.
16//!
17//! ```no_run
18//! use anyhow::Error;
19//! use carnelian::{
20//!     make_app_assistant,
21//!     render::{self},
22//!     App, AppAssistant, ViewAssistant, ViewAssistantContext, ViewAssistantPtr, ViewKey,
23//! };
24//! use zx::Event;
25//!
26//! #[derive(Default)]
27//! struct SampleAppAssistant;
28//!
29//! impl AppAssistant for SampleAppAssistant {
30//!     fn setup(&mut self) -> Result<(), Error> {
31//!         Ok(())
32//!     }
33//!
34//!     fn create_view_assistant(&mut self, _: ViewKey) -> Result<ViewAssistantPtr, Error> {
35//!         SampleViewAssistant::new()
36//!     }
37//! }
38//!
39//! struct SampleViewAssistant;
40//!
41//! impl SampleViewAssistant {
42//!     fn new() -> Result<ViewAssistantPtr, Error> {
43//!         Ok(Box::new(Self {}))
44//!     }
45//! }
46//!
47//! impl ViewAssistant for SampleViewAssistant {
48//!     fn render(
49//!         &mut self,
50//!         _render_context: &mut render::Context,
51//!         _buffer_ready_event: Event,
52//!         _view_context: &ViewAssistantContext,
53//!     ) -> Result<(), Error> {
54//!         Ok(())
55//!     }
56//! }
57//!
58//! fn main() -> Result<(), Error> {
59//!     App::run(make_app_assistant::<SampleAppAssistant>())
60//! }
61//! ```
62
63#![deny(missing_docs)]
64
65use std::marker::PhantomData;
66use std::sync::atomic::{AtomicU64, Ordering};
67
68/// Application related items
69pub mod app;
70/// Color-related items
71pub mod color;
72/// Drawing-related items
73pub mod drawing;
74/// Geometry-related items.
75pub mod geometry;
76/// Input-related items.
77pub mod input;
78/// Extension items related to input.
79pub mod input_ext;
80mod message;
81/// Render-related items.
82pub mod render;
83/// UI item abstraction
84pub mod scene;
85mod view;
86
87pub(crate) trait IdFromRaw {
88    fn from_raw(id: u64) -> Self;
89}
90
91#[derive(Default)]
92pub(crate) struct IdGenerator2<T> {
93    id_type: PhantomData<T>,
94}
95
96impl<T> IdGenerator2<T>
97where
98    T: IdFromRaw + std::fmt::Debug,
99{
100    fn next() -> Option<T> {
101        static NEXT_ID: AtomicU64 = AtomicU64::new(100);
102        let id = NEXT_ID.fetch_add(1, Ordering::SeqCst);
103        // fetch_add wraps on overflow, which we'll use as a signal
104        // that this generator is out of ids.
105        if id == 0 {
106            None
107        } else {
108            Some(T::from_raw(id))
109        }
110    }
111}
112
113pub use crate::app::{
114    make_app_assistant, App, AppAssistant, AppAssistantPtr, AppSender, AssistantCreator,
115    AssistantCreatorFunc, LocalBoxFuture, MessageTarget,
116};
117pub use crate::geometry::{Coord, IntCoord, IntPoint, IntRect, IntSize, Point, Rect, Size};
118pub use crate::message::{make_message, Message};
119pub use crate::view::{ViewAssistant, ViewAssistantContext, ViewAssistantPtr, ViewKey};
carnelian/lib.rs

carnelian/
lib.rs
