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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! References/slices that provide write-access, but no read-access.
//!
//! # Examples
//!
//! Write-only reference:
//! ```
//! use write_only::{prelude::*, Put};
//!
//! fn write<T: Put<u8>>(write_only: &mut T) {
//!     write_only.put(42u8);
//! }
//!
//! let mut value: u8 = 0;
//!
//! let mut write_only = WriteOnlyRef::from(&mut value);
//! write(&mut write_only);
//!
//! assert_eq!(value, 42);
//!```
//!
//! Write-only slice:
//! ```
//! use write_only::{prelude::*, PutAt};
//!
//! fn write<T: PutAt<u8>>(write_only: &mut T) {
//!     write_only.put_at(2, 42u8);
//! }
//!
//! let mut values: Vec<u8> = (0..10).collect();
//!
//! let mut write_only = WriteOnlySlice::from(&mut values[..]);
//! write(&mut write_only);
//!
//! assert_eq!(values[2], 42u8);
//! ```

#![cfg_attr(not(feature = "std"), no_std)]

mod reference;
mod slice;

pub use reference::{Put, VolatileWriteOnlyRef, Write, WriteOnlyRef};
pub use slice::{
    PutAt, PutFromSliceAt, VolatileWriteOnlySlice, WriteAt, WriteFromSliceAt, WriteOnlySlice,
};

/// The crate's prelude.
pub mod prelude {
    pub use crate::reference::{Put as _, VolatileWriteOnlyRef, Write as _, WriteOnlyRef};
    pub use crate::slice::{
        PutAt as _, PutFromSliceAt as _, VolatileWriteOnlySlice, WriteAt as _,
        WriteFromSliceAt as _, WriteOnlySlice,
    };
}