Skip to content

Commit daab3b2

Browse files
curryyzhengLuthaf
authored andcommitted
doc: mapping for soa_attr first argument to generated struct
1 parent 5bb494c commit daab3b2

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,15 @@ pub struct Cheese {
7070
}
7171
```
7272

73+
Mappings for first argument of ``soa_attr`` to the generated struct for ``Cheese``:
74+
* `Vec` => `CheeseVec`
75+
* `Slice` => `CheeseSlice`
76+
* `SliceMut` => `CheeseSliceMut`
77+
* `Ref` => `CheeseRef`
78+
* `RefMut` => `CheeseRefMut`
79+
* `Ptr` => `CheesePtr`
80+
* `PtrMut` => `CheesePtrMut`
81+
7382
## Usage and API
7483

7584
All the generated code have some generated documentation with it, so you

src/lib.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,14 @@
7171
//! # }
7272
//! ```
7373
//!
74-
//! Possible options for first argument of ``soa_attr`` attribute: `Vec`, `Slice`,
75-
//! `Ref` and `Ptr`.
74+
//! Mappings for first argument of ``soa_attr`` to the generated struct for ``Cheese``:
75+
//! * `Vec` => `CheeseVec`
76+
//! * `Slice` => `CheeseSlice`
77+
//! * `SliceMut` => `CheeseSliceMut`
78+
//! * `Ref` => `CheeseRef`
79+
//! * `RefMut` => `CheeseRefMut`
80+
//! * `Ptr` => `CheesePtr`
81+
//! * `PtrMut` => `CheesePtrMut`
7682
//!
7783
//! # Usage and API
7884
//!

0 commit comments

Comments
 (0)