flense 0.4.0

Purpose-oriented lensing
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

//! Concrete lens definitions.

#[expect(
    clippy::module_inception,
    reason = "hidden module used for organization"
)]
mod lens;
mod lens_mut;
mod raw;

pub use lens::{
    LensBase,
    join_lens,
    try_join_lens,
    zip_lens,
};
pub use lens_mut::{
    LensBaseMut,
    join_lens_mut,
    try_join_lens_mut,
    zip_lens_mut,
};

/// Zero-dimensional lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&` reference is to references.
pub type Lens<'a, T> = LensBase<'a, T, 0>;
/// Zero-dimensional mutable lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&mut` reference is to references.
pub type LensMut<'a, T> = LensBaseMut<'a, T, 0>;

/// One-dimensional lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&[_]` reference is to references.
pub type LensSlice<'a, T> = LensBase<'a, T, 1>;
/// One-dimensional mutable lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&mut [_]` reference is to references.
pub type LensSliceMut<'a, T> = LensBaseMut<'a, T, 1>;

/// Two-dimensional lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&[&[_]]` reference is to references.
pub type LensRect<'a, T> = LensBase<'a, T, 2>;
/// Two-dimensional mutable lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&mut [&mut [_]]` reference is to references.
pub type LensRectMut<'a, T> = LensBaseMut<'a, T, 2>;

/// Three-dimensional lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&[&[&[_]]]` reference is to references.
pub type LensCube<'a, T> = LensBase<'a, T, 3>;
/// Three-dimensional mutable lens to a set of [`Field`](crate::Field).
///
/// This is to lensing what a `&mut [&mut [&mut [_]]]` reference is to
/// references.
pub type LensCubeMut<'a, T> = LensBaseMut<'a, T, 3>;