├── triagebot.toml ├── .github ├── CODEOWNERS └── workflows │ ├── rustfmt.yml │ ├── clippy.yml │ └── ci.yml ├── .gitignore ├── Cargo.toml ├── LICENSE-MIT ├── CHANGELOG.md ├── README.md ├── CODE_OF_CONDUCT.md ├── src └── lib.rs └── LICENSE-APACHE /triagebot.toml: -------------------------------------------------------------------------------- 1 | [assign] 2 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @rust-embedded/hal 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **/*.rs.bk 2 | .#* 3 | /target/ 4 | Cargo.lock 5 | -------------------------------------------------------------------------------- /.github/workflows/rustfmt.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: # Run CI for all branches except GitHub merge queue tmp branches 3 | branches-ignore: 4 | - "gh-readonly-queue/**" 5 | pull_request: # Run CI for PRs on any branch 6 | merge_group: # Run CI for the GitHub merge queue 7 | 8 | name: Code formatting check 9 | 10 | jobs: 11 | fmt: 12 | name: Rustfmt 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v3 16 | - uses: dtolnay/rust-toolchain@master 17 | with: 18 | toolchain: 1.71.0 19 | components: rustfmt 20 | - run: cargo fmt --all -- --check 21 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | authors = ["Jorge Aparicio "] 3 | categories = ["asynchronous", "embedded", "no-std"] 4 | description = "Minimal non-blocking I/O layer" 5 | keywords = ["await", "futures", "IO"] 6 | license = "MIT OR Apache-2.0" 7 | name = "nb" 8 | repository = "https://github.com/rust-embedded/nb" 9 | homepage = "https://github.com/rust-embedded/nb" 10 | documentation = "https://docs.rs/nb" 11 | readme = "README.md" 12 | version = "1.1.0" 13 | edition = "2018" 14 | rust-version = "1.62" 15 | 16 | [features] 17 | "defmt-0-3" = ["dep:defmt"] 18 | 19 | [dependencies] 20 | defmt = {version = "0.3", optional = true} -------------------------------------------------------------------------------- /.github/workflows/clippy.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: # Run CI for all branches except GitHub merge queue tmp branches 3 | branches-ignore: 4 | - "gh-readonly-queue/**" 5 | pull_request: # Run CI for PRs on any branch 6 | merge_group: # Run CI for the GitHub merge queue 7 | 8 | name: Clippy check 9 | 10 | env: 11 | RUSTFLAGS: '-D warnings' 12 | 13 | jobs: 14 | clippy_check: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - uses: actions/checkout@v3 18 | - uses: dtolnay/rust-toolchain@master 19 | with: 20 | toolchain: 1.71.0 21 | components: clippy 22 | - run: cargo clippy --all-targets --all-features 23 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2017 Jorge Aparicio 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: # Run CI for all branches except GitHub merge queue tmp branches 3 | branches-ignore: 4 | - "gh-readonly-queue/**" 5 | pull_request: # Run CI for PRs on any branch 6 | merge_group: # Run CI for the GitHub merge queue 7 | 8 | name: Continuous integration 9 | 10 | env: 11 | RUSTFLAGS: '--deny warnings' 12 | 13 | jobs: 14 | ci-linux: 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | rust: 19 | - stable 20 | - 1.62.0 # MSRV 21 | 22 | features: 23 | - '' 24 | - 'defmt-0-3' 25 | 26 | target: 27 | - x86_64-unknown-linux-gnu 28 | - thumbv6m-none-eabi 29 | 30 | include: 31 | # Test nightly but don't fail 32 | - rust: nightly 33 | target: x86_64-unknown-linux-gnu 34 | features: '' 35 | experimental: true 36 | 37 | steps: 38 | - uses: actions/checkout@v3 39 | - uses: dtolnay/rust-toolchain@master 40 | with: 41 | toolchain: ${{ matrix.rust }} 42 | target: ${{ matrix.target }} 43 | 44 | - run: cargo check --target=${{ matrix.target }} --features=${{ matrix.features }} 45 | - run: cargo test --target=${{ matrix.target }} --features=${{ matrix.features }} 46 | if: contains(matrix.target, 'linux') 47 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](http://keepachangelog.com/) 6 | and this project adheres to [Semantic Versioning](http://semver.org/). 7 | 8 | ## [Unreleased] 9 | 10 | ### Changed 11 | - Raised MSRV to 1.62.0 12 | 13 | ## [v1.1.0] - 2023-03-07 14 | 15 | ### Added 16 | 17 | - Add `defmt` as optional dependency and implement `defmt::Format` for `Error`, enabled by `defmt-0-3` unstable feature. 18 | 19 | ## [v1.0.0] - 2020-07-07 20 | 21 | ### Changed 22 | 23 | - [breaking-change] The `unstable` feature and its code has been removed. 24 | This includes the macros `try_nb!` and `await!`. 25 | 26 | ## [v0.1.2] - 2019-04-21 27 | 28 | ### Added 29 | 30 | - `Error` gained a `map` method that lets you transform the error in the 31 | `Error::Other` variant into a different type. 32 | 33 | - `Error` now implements the `From` trait. 34 | 35 | ## [v0.1.1] - 2018-01-10 36 | 37 | ### Fixed 38 | 39 | - The `await!` macro now works when the expression `$e` mutably borrows `self`. 40 | 41 | ## v0.1.0 - 2018-01-10 42 | 43 | Initial release 44 | 45 | [Unreleased]: https://github.com/rust-embedded/nb/compare/v1.1.0...HEAD 46 | [v1.1.0]: https://github.com/rust-embedded/nb/compare/v1.0.0...v1.1.0 47 | [v1.0.0]: https://github.com/rust-embedded/nb/compare/v0.1.2...v1.0.0 48 | [v0.1.2]: https://github.com/rust-embedded/nb/compare/v0.1.1...v0.1.2 49 | [v0.1.1]: https://github.com/rust-embedded/nb/compare/v0.1.0...v0.1.1 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![crates.io](https://img.shields.io/crates/d/nb.svg)](https://crates.io/crates/nb) 2 | [![crates.io](https://img.shields.io/crates/v/nb.svg)](https://crates.io/crates/nb) 3 | [![Documentation](https://docs.rs/nb/badge.svg)](https://docs.rs/nb) 4 | ![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.62+-blue.svg) 5 | 6 | # `nb` 7 | 8 | > Minimal and reusable non-blocking I/O layer 9 | 10 | This project is developed and maintained by the [HAL team][team]. 11 | 12 | ## [Documentation](https://docs.rs/nb) 13 | 14 | The ultimate goal of this crate is *code reuse*. With this crate you can 15 | write *core* I/O APIs that can then be adapted to operate in either blocking 16 | or non-blocking manner. Furthermore those APIs are not tied to a particular 17 | asynchronous model and can be adapted to work with the `futures` model or 18 | with the `async` / `await` model. 19 | 20 | ### Core idea 21 | 22 | The [`WouldBlock`](enum.Error.html) error variant signals that the operation 23 | can't be completed *right now* and would need to block to complete. 24 | [`WouldBlock`](enum.Error.html) is a special error in the sense that it's not 25 | *fatal*; the operation can still be completed by retrying again later. 26 | 27 | [`nb::Result`](type.Result.html) is based on the API of 28 | [`std::io::Result`](https://doc.rust-lang.org/std/io/type.Result.html), 29 | which has a `WouldBlock` variant in its 30 | [`ErrorKind`](https://doc.rust-lang.org/std/io/enum.ErrorKind.html). 31 | 32 | We can map [`WouldBlock`](enum.Error.html) to different blocking and 33 | non-blocking models: 34 | 35 | - In blocking mode, [`WouldBlock`](enum.Error.html) means try again right 36 | now, i.e. busy waiting. 37 | - In `async` mode, [`WouldBlock`](enum.Error.html) means 38 | [`Poll::Pending`](https://doc.rust-lang.org/core/task/enum.Poll.html#variant.Pending). 39 | 40 | 41 | ## Minimum Supported Rust Version (MSRV) 42 | 43 | This crate is guaranteed to compile on stable Rust 1.62 and up. It *might* 44 | compile with older versions but that may change in any new patch release. 45 | 46 | ## License 47 | 48 | Licensed under either of 49 | 50 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or 51 | ) 52 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or ) 53 | 54 | at your option. 55 | 56 | ### Contribution 57 | 58 | Unless you explicitly state otherwise, any contribution intentionally submitted 59 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall be 60 | dual licensed as above, without any additional terms or conditions. 61 | 62 | ## Code of Conduct 63 | 64 | Contribution to this crate is organized under the terms of the [Rust Code of 65 | Conduct][CoC], the maintainer of this crate, the [HAL team][team], promises 66 | to intervene to uphold that code of conduct. 67 | 68 | [CoC]: CODE_OF_CONDUCT.md 69 | [team]: https://github.com/rust-embedded/wg#the-hal-team 70 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # The Rust Code of Conduct 2 | 3 | ## Conduct 4 | 5 | **Contact**: [HAL team][team] 6 | 7 | * We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic. 8 | * On IRC, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all. 9 | * Please be kind and courteous. There's no need to be mean or rude. 10 | * Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer. 11 | * Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works. 12 | * We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term "harassment" as including the definition in the [Citizen Code of Conduct](http://citizencodeofconduct.org/); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups. 13 | * Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [HAL team][team] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back. 14 | * Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome. 15 | 16 | ## Moderation 17 | 18 | These are the policies for upholding our community's standards of conduct. 19 | 20 | 1. Remarks that violate the Rust standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.) 21 | 2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed. 22 | 3. Moderators will first respond to such remarks with a warning. 23 | 4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of the communication channel to cool off. 24 | 5. If the user comes back and continues to make trouble, they will be banned, i.e., indefinitely excluded. 25 | 6. Moderators may choose at their discretion to un-ban the user if it was a first offense and they offer the offended party a genuine apology. 26 | 7. If a moderator bans someone and you think it was unjustified, please take it up with that moderator, or with a different moderator, **in private**. Complaints about bans in-channel are not allowed. 27 | 8. Moderators are held to a higher standard than other community members. If a moderator creates an inappropriate situation, they should expect less leeway than others. 28 | 29 | In the Rust community we strive to go the extra step to look out for each other. Don't just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they're off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely. 30 | 31 | And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could've communicated better — remember that it's your responsibility to make your fellow Rustaceans comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust. 32 | 33 | The enforcement policies listed above apply to all official embedded WG venues; including official IRC channels (#rust-embedded); GitHub repositories under rust-embedded; and all forums under rust-embedded.org (forum.rust-embedded.org). 34 | 35 | *Adapted from the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](https://www.contributor-covenant.org/version/1/3/0/).* 36 | 37 | [team]: https://github.com/rust-embedded/wg#the-hal-team 38 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![doc = include_str!("../README.md")] 2 | //! 3 | //! # How to use this crate 4 | //! 5 | //! Application specific errors can be put inside the `Other` variant in the 6 | //! [`nb::Error`](enum.Error.html) enum. 7 | //! 8 | //! So in your API instead of returning `Result` return 9 | //! `nb::Result` 10 | //! 11 | //! ``` 12 | //! enum MyError { 13 | //! ThisError, 14 | //! ThatError, 15 | //! // .. 16 | //! } 17 | //! 18 | //! // This is a blocking function, so it returns a normal `Result` 19 | //! fn before() -> Result<(), MyError> { 20 | //! // .. 21 | //! # Ok(()) 22 | //! } 23 | //! 24 | //! // This is now a potentially (read: *non*) blocking function so it returns `nb::Result` 25 | //! // instead of blocking 26 | //! fn after() -> nb::Result<(), MyError> { 27 | //! // .. 28 | //! # Ok(()) 29 | //! } 30 | //! ``` 31 | //! 32 | //! You can use `Infallible` to signal that some API has no fatal 33 | //! errors but may block: 34 | //! 35 | //! ``` 36 | //! use core::convert::Infallible; 37 | //! 38 | //! // This returns `Ok(())` or `Err(nb::Error::WouldBlock)` 39 | //! fn maybe_blocking_api() -> nb::Result<(), Infallible> { 40 | //! // .. 41 | //! # Ok(()) 42 | //! } 43 | //! ``` 44 | //! 45 | //! Once your API uses [`nb::Result`] you can leverage the [`block!`], macro 46 | //! to adapt it for blocking operation, or handle scheduling yourself. 47 | //! 48 | //! [`block!`]: macro.block.html 49 | //! [`nb::Result`]: type.Result.html 50 | //! 51 | //! # Examples 52 | //! 53 | //! ## A Core I/O API 54 | //! 55 | //! Imagine the code (crate) below represents a Hardware Abstraction Layer for some microcontroller 56 | //! (or microcontroller family). 57 | //! 58 | //! *In this and the following examples let's assume for simplicity that peripherals are treated 59 | //! as global singletons and that no preemption is possible (i.e. interrupts are disabled).* 60 | //! 61 | //! ``` 62 | //! # use core::convert::Infallible; 63 | //! // This is the `hal` crate 64 | //! use nb; 65 | //! 66 | //! /// An LED 67 | //! pub struct Led; 68 | //! 69 | //! impl Led { 70 | //! pub fn off(&self) { 71 | //! // .. 72 | //! } 73 | //! pub fn on(&self) { 74 | //! // .. 75 | //! } 76 | //! } 77 | //! 78 | //! /// Serial interface 79 | //! pub struct Serial; 80 | //! pub enum Error { 81 | //! Overrun, 82 | //! // .. 83 | //! } 84 | //! 85 | //! impl Serial { 86 | //! /// Reads a single byte from the serial interface 87 | //! pub fn read(&self) -> nb::Result { 88 | //! // .. 89 | //! # Ok(0) 90 | //! } 91 | //! 92 | //! /// Writes a single byte to the serial interface 93 | //! pub fn write(&self, byte: u8) -> nb::Result<(), Error> { 94 | //! // .. 95 | //! # Ok(()) 96 | //! } 97 | //! } 98 | //! 99 | //! /// A timer used for timeouts 100 | //! pub struct Timer; 101 | //! 102 | //! impl Timer { 103 | //! /// Waits until the timer times out 104 | //! pub fn wait(&self) -> nb::Result<(), Infallible> { 105 | //! //^ NOTE the `Infallible` indicates that this operation can block but has no 106 | //! // other form of error 107 | //! 108 | //! // .. 109 | //! # Ok(()) 110 | //! } 111 | //! } 112 | //! ``` 113 | //! 114 | //! ## Blocking mode 115 | //! 116 | //! Turn on an LED for one second and *then* loops back serial data. 117 | //! 118 | //! ``` 119 | //! use core::convert::Infallible; 120 | //! use nb::block; 121 | //! 122 | //! use hal::{Led, Serial, Timer}; 123 | //! 124 | //! # fn main() -> Result<(), Infallible> { 125 | //! // Turn the LED on for one second 126 | //! Led.on(); 127 | //! block!(Timer.wait())?; 128 | //! Led.off(); 129 | //! 130 | //! // Serial interface loopback 131 | //! # return Ok(()); 132 | //! loop { 133 | //! let byte = block!(Serial.read())?; 134 | //! block!(Serial.write(byte))?; 135 | //! } 136 | //! # } 137 | //! 138 | //! # mod hal { 139 | //! # use nb; 140 | //! # use core::convert::Infallible; 141 | //! # pub struct Led; 142 | //! # impl Led { 143 | //! # pub fn off(&self) {} 144 | //! # pub fn on(&self) {} 145 | //! # } 146 | //! # pub struct Serial; 147 | //! # impl Serial { 148 | //! # pub fn read(&self) -> nb::Result { Ok(0) } 149 | //! # pub fn write(&self, _: u8) -> nb::Result<(), Infallible> { Ok(()) } 150 | //! # } 151 | //! # pub struct Timer; 152 | //! # impl Timer { 153 | //! # pub fn wait(&self) -> nb::Result<(), Infallible> { Ok(()) } 154 | //! # } 155 | //! # } 156 | //! ``` 157 | //! 158 | //! # Features 159 | //! 160 | //! - `defmt-0-3` - unstable feature which adds [`defmt::Format`] impl for [`Error`]. 161 | 162 | #![no_std] 163 | 164 | use core::fmt; 165 | 166 | /// A non-blocking result 167 | pub type Result = ::core::result::Result>; 168 | 169 | /// A non-blocking error 170 | /// 171 | /// The main use of this enum is to add a `WouldBlock` variant to an existing 172 | /// error enum. 173 | #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] 174 | pub enum Error { 175 | /// A different kind of error 176 | Other(E), 177 | /// This operation requires blocking behavior to complete 178 | WouldBlock, 179 | } 180 | 181 | #[cfg(feature = "defmt-0-3")] 182 | impl defmt::Format for Error 183 | where 184 | E: defmt::Format, 185 | { 186 | fn format(&self, f: defmt::Formatter) { 187 | match *self { 188 | Error::Other(ref e) => defmt::Format::format(e, f), 189 | Error::WouldBlock => defmt::write!(f, "WouldBlock",), 190 | } 191 | } 192 | } 193 | 194 | impl fmt::Debug for Error 195 | where 196 | E: fmt::Debug, 197 | { 198 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 199 | match *self { 200 | Error::Other(ref e) => fmt::Debug::fmt(e, f), 201 | Error::WouldBlock => f.write_str("WouldBlock"), 202 | } 203 | } 204 | } 205 | 206 | impl Error { 207 | /// Maps an `Error` to `Error` by applying a function to a contained 208 | /// `Error::Other` value, leaving an `Error::WouldBlock` value untouched. 209 | pub fn map(self, op: F) -> Error 210 | where 211 | F: FnOnce(E) -> T, 212 | { 213 | match self { 214 | Error::Other(e) => Error::Other(op(e)), 215 | Error::WouldBlock => Error::WouldBlock, 216 | } 217 | } 218 | } 219 | 220 | impl From for Error { 221 | fn from(error: E) -> Error { 222 | Error::Other(error) 223 | } 224 | } 225 | 226 | /// Turns the non-blocking expression `$e` into a blocking operation. 227 | /// 228 | /// This is accomplished by continuously calling the expression `$e` until it no 229 | /// longer returns `Error::WouldBlock` 230 | /// 231 | /// # Input 232 | /// 233 | /// An expression `$e` that evaluates to `nb::Result` 234 | /// 235 | /// # Output 236 | /// 237 | /// - `Ok(t)` if `$e` evaluates to `Ok(t)` 238 | /// - `Err(e)` if `$e` evaluates to `Err(nb::Error::Other(e))` 239 | #[macro_export] 240 | macro_rules! block { 241 | ($e:expr) => { 242 | loop { 243 | #[allow(unreachable_patterns)] 244 | match $e { 245 | Err($crate::Error::Other(e)) => 246 | { 247 | #[allow(unreachable_code)] 248 | break Err(e) 249 | } 250 | Err($crate::Error::WouldBlock) => {} 251 | Ok(x) => break Ok(x), 252 | } 253 | } 254 | }; 255 | } 256 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------