obel_platform 0.0.9

Platform agnostic support
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# Obel Platform

[![license](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/obelengine/obel#license)
[![crates.io](https://img.shields.io/crates/v/obel.svg)](https://crates.io/crates/obel)
[![downloads](https://img.shields.io/crates/d/obel.svg)](https://crates.io/crates/obel)
[![docs.rs](https://docs.rs/obel/badge.svg)](https://docs.rs/obel/latest/obel/)
[![discord.online](https://img.shields.io/discord/1335036405788971020.svg?label=&logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/3jq8js8u)

## Overview

`obel_platform` is a specialized crate designed to enhance cross-platform development  
for [Obel](https://crates.io/crates/nita_obel) game engine projects. While Rust's [standard library](https://doc.rust-lang.org/stable/std/) provides excellent multi-platform support,  
this crate offers optimized alternatives specifically tailored for game development and embedded systems.

Key benefits:

- Platform-optimized alternatives to standard library components
- First-class support for [`no_std`](https://docs.rust-embedded.org/book/intro/no-std.html) environments
- Seamless integration with Bevy ecosystem

## Installation

Add the crate to your project using cargo:

```sh
cargo add obel_platform
```

## Usage

Simply import from `obel_platform` instead of `std` for supported items. Refer to the [documentation](https://docs.rs/obel_platform/latest/obel_platform/) for available items and their benefits.

## Features

### Standard Library Support (`std`) [default]

- Enables standard library integration
- Provides optimized alternatives where beneficial
- Incompatible with `no_std` targets

### Allocation Support (`alloc`) [default]

- Enables [`alloc`](https://doc.rust-lang.org/stable/alloc/) crate functionality
- Automatically enabled with `std` feature
- Compatible with most `no_std` targets

### Portable Atomics (`portable-atomic`)

- Uses [`portable-atomic`](https://docs.rs/portable-atomic/latest/portable_atomic/) for atomic operations
- Essential for platforms with limited atomic operation support
- Provides consistent atomic behavior across platforms

### Critical Section Support (`critical-section`)

- Implements synchronization using [`critical-section`](https://docs.rs/critical-section/latest/critical_section/)
- Ideal for platforms with minimal atomic operation support
- Often used in conjunction with `portable-atomic`

## No-std Configuration

To use on generic(`no_std`) platforms, disable default features but enable `other` feature in your `Cargo.toml`:

```toml
obel_platform = { version = "x.y.z", default-features = false, features = ["generic"]  }
```