gstd/sync/
mod.rs

1// This file is part of Gear.
2
3// Copyright (C) 2021-2025 Gear Technologies Inc.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Data access synchronization objects.
20//!
21//! These synchronization objects are similar to those in the [`std::sync`](https://doc.rust-lang.org/std/sync/) module, but they prevent data races when dealing with multiple actors (users or programs) instead of multiple threads considered in classic synchronization objects.
22//!
23//! The following is an overview of the available synchronization objects:
24//!
25//! - [`Mutex`]: The Mutual Exclusion mechanism guarantees that during
26//!   execution, only a single actor can access data at any given time.
27//! - [`RwLock`]: Provides a mutual exclusion mechanism that allows multiple
28//!   readings by different actors while allowing only one writer at the
29//!   execution. In some cases, this can be more efficient than a mutex.
30
31mod access;
32
33mod mutex;
34mod rwlock;
35
36pub use self::{
37    mutex::{Mutex, MutexGuard, MutexLockFuture},
38    rwlock::{RwLock, RwLockReadFuture, RwLockReadGuard, RwLockWriteFuture, RwLockWriteGuard},
39};
40
41pub(crate) use self::mutex::MutexId;