Skip to content

Commit dbde383

Browse files
CAD97CAD97
committed
README and metadata
1 parent 321d133 commit dbde383

File tree

13 files changed

+488
-10
lines changed

13 files changed

+488
-10
lines changed

‎.github/workflows/ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- name: Install Rust toolchain
2323
uses: actions-rs/toolchain@v1
2424
with:
25-
toolchain: nightly
25+
toolchain: beta
2626
profile: minimal
2727
override: true
2828

‎.github/workflows/rustdoc.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- name: Install Rust toolchain
1818
uses: actions-rs/toolchain@v1
1919
with:
20-
toolchain: nightly
20+
toolchain: beta
2121
profile: minimal
2222
override: true
2323

‎LICENSE/APACHE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎LICENSE/MIT

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Christopher Durham (aka CAD97)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+29-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
# Pointer utility crates
22

3-
- [`erasable`](crates/erasable):
4-
Erase pointers of their concrete type.
5-
- [`rc-borrow`](crates/rc-borrow):
6-
Borrowed forms of `Rc` and `Arc`.
7-
- [`rc-box`](crates/rc-box):
8-
Known unique forms of `Rc` and `Arc`.
9-
- [`ptr-union`](crates/ptr-union):
10-
Pointer unions the size of a pointer.
3+
- [`erasable`](crates/erasable): Erase pointers of their concrete type.
4+
- [`rc-borrow`](crates/rc-borrow): Borrowed forms of `Rc` and `Arc`.
5+
- [`rc-box`](crates/rc-box): Known unique forms of `Rc` and `Arc`.
6+
- [`ptr-union`](crates/ptr-union): Pointer unions the size of a pointer.
117

128
## Why not [triomphe](https://crates.io/crates/triomphe)?
139

@@ -32,3 +28,28 @@ This is for an adjustment of local trait impl checking.
3228

3329
The minimum version of Rust will only be incremented with minor version bumps,
3430
not patch version bumps, and will be deliberate and clearly noted in change notes.
31+
32+
## License
33+
34+
Licensed under either of
35+
36+
* Apache License, Version 2.0
37+
([LICENSE/APACHE](LICENSE/APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
38+
* MIT license
39+
([LICENSE/MIT](LICENSE/MIT) or http://opensource.org/licenses/MIT)
40+
41+
at your option.
42+
43+
If you are a highly paid worker at any company that prioritises profit over
44+
people, you can still use this crate. I simply wish you will unionise and push
45+
back against the obsession for growth, control, and power that is rampant in
46+
your workplace. Please take a stand against the horrible working conditions
47+
they inflict on your lesser paid colleagues, and more generally their
48+
disrespect for the very human rights they claim to fight for.
49+
50+
## Contribution
51+
52+
Unless you explicitly state otherwise, any contribution intentionally submitted
53+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
54+
dual licensed as above, without any additional terms or conditions.
55+

‎crates/erasable/Cargo.toml

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ version = "1.0.0-dev"
44
edition = "2018"
55

66
authors = ["Christopher Durham (cad97) <[email protected]>"]
7+
description = "Type-erased thin pointers."
8+
repository = "https://github.com/CAD97/pointer-utils/tree/master/crates/erasable"
9+
readme = "README.md"
10+
keywords = ["thin","pointer","type","erasure"]
11+
categories = ["data-structures","no-std","rust-patterns"]
12+
license = "MIT OR APACHE-2.0"
13+
14+
[badges]
15+
maintenance = { status = "passively-maintained" }
716

817
[features]
918
default = ["alloc"]

‎crates/erasable/README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Erase pointers of their concrete type and store type-erased pointers.
2+
3+
This is roughly equivalent to C's `void*`, but it does not use `libc::c_void`.
4+
5+
There are two main useful reasons to type erase pointers in Rust:
6+
7+
- Removing viral generics from internal implementation details.
8+
If the internals truly don't care about the stored type,
9+
treating it opaquely reduces monomorphization cost
10+
both to the author and the compiler.
11+
- Thin pointers to `?Sized` types. If an unsized type stores its metadata inline,
12+
then it can implement [`Erasable`] and be used behind type-erased pointers.
13+
The type erased pointer does not have to carry the metadata,
14+
and the fat pointer can be recovered from the inline metadata.
15+
We provide the [`Thin`] wrapper type to provide thin pointer types.
16+
17+
## Related Crates
18+
19+
- [`ptr-union`](https://lib.rs/crates/ptr-union): Pointer unions the size of a pointer.
20+
- [`rc-borrow`](https://lib.rs/crates/rc-borrow): Borrowed forms of `Rc` and `Arc`.
21+
- [`rc-box`](https://lib.rs/crates/rc-box): Known unique forms of `Rc` and `Arc`.
22+
23+
## Minimum Supported Rust Version
24+
25+
We require a minimum Rust version of 1.41.0.
26+
This is for an adjustment of local trait impl checking.
27+
28+
The minimum version of Rust will only be incremented with minor version bumps,
29+
not patch version bumps, and will be deliberate and clearly noted in change notes.
30+
31+
## License
32+
33+
Licensed under either of
34+
35+
* Apache License, Version 2.0
36+
([LICENSE/APACHE](../../LICENSE/APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
37+
* MIT license
38+
([LICENSE/MIT](../../LICENSE/MIT) or http://opensource.org/licenses/MIT)
39+
40+
at your option.
41+
42+
If you are a highly paid worker at any company that prioritises profit over
43+
people, you can still use this crate. I simply wish you will unionise and push
44+
back against the obsession for growth, control, and power that is rampant in
45+
your workplace. Please take a stand against the horrible working conditions
46+
they inflict on your lesser paid colleagues, and more generally their
47+
disrespect for the very human rights they claim to fight for.
48+
49+
## Contribution
50+
51+
Unless you explicitly state otherwise, any contribution intentionally submitted
52+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
53+
dual licensed as above, without any additional terms or conditions.

‎crates/ptr-union/Cargo.toml

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ version = "1.0.0-dev"
44
edition = "2018"
55

66
authors = ["Christopher Durham (cad97) <[email protected]>"]
7+
description = "Pointer union types the size of a pointer by storing the tag in the alignment bits."
8+
repository = "https://github.com/CAD97/pointer-utils/tree/master/crates/ptr-union"
9+
readme = "README.md"
10+
keywords = ["thin","pointer","union","enum"]
11+
categories = ["data-structures","no-std","rust-patterns"]
12+
license = "MIT OR APACHE-2.0"
13+
14+
[badges]
15+
maintenance = { status = "passively-maintained" }
716

817
[dependencies]
918
paste = "0.1.6"

‎crates/ptr-union/README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Pointer union types the size of a pointer
2+
by storing the tag in the alignment bits.
3+
4+
## Minimum Supported Rust Version
5+
6+
We require a minimum Rust version of 1.41.0.
7+
This is for an adjustment of local trait impl checking.
8+
9+
The minimum version of Rust will only be incremented with minor version bumps,
10+
not patch version bumps, and will be deliberate and clearly noted in change notes.
11+
12+
## Related Crates
13+
14+
- [`erasable`](https://lib.rs/crates/erasable): Erase pointers of their concrete type.
15+
- [`rc-borrow`](https://lib.rs/crates/rc-borrow): Borrowed forms of `Rc` and `Arc`.
16+
- [`rc-box`](https://lib.rs/crates/rc-box): Known unique forms of `Rc` and `Arc`.
17+
18+
## License
19+
20+
Licensed under either of
21+
22+
* Apache License, Version 2.0
23+
([LICENSE/APACHE](../../LICENSE/APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
24+
* MIT license
25+
([LICENSE/MIT](../../LICENSE/MIT) or http://opensource.org/licenses/MIT)
26+
27+
at your option.
28+
29+
If you are a highly paid worker at any company that prioritises profit over
30+
people, you can still use this crate. I simply wish you will unionise and push
31+
back against the obsession for growth, control, and power that is rampant in
32+
your workplace. Please take a stand against the horrible working conditions
33+
they inflict on your lesser paid colleagues, and more generally their
34+
disrespect for the very human rights they claim to fight for.
35+
36+
## Contribution
37+
38+
Unless you explicitly state otherwise, any contribution intentionally submitted
39+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
40+
dual licensed as above, without any additional terms or conditions.

0 commit comments

Comments
 (0)