4 releases (2 stable)

1.1.0 Apr 15, 2021
1.0.0 Apr 6, 2021
1.0.0-beta Apr 4, 2021

#231 in Embedded development

Download history 107/week @ 2021-10-04 10/week @ 2021-10-11 2/week @ 2021-10-18 2/week @ 2021-10-25 2/week @ 2021-11-01 5/week @ 2021-11-08 6/week @ 2021-11-15 3/week @ 2021-11-22 12/week @ 2021-11-29 4/week @ 2021-12-06 25/week @ 2021-12-13 13/week @ 2021-12-20 4/week @ 2021-12-27 179/week @ 2022-01-03 244/week @ 2022-01-10 15/week @ 2022-01-17

442 downloads per month
Used in 2 crates

MIT OR Apache-2.0 OR Zlib

26KB
345 lines

unsize

Crates.io Status Docs.rs Status License CI Status

Goals and Targets

In embedded environments there are quite many use cases for custom smart pointers, for example to encapsulate ownership of objects on the stack or within a custom arena etc. One also wants to avoid unnecessary monomorphization that is for code size it is often desirable to use a dynamic trait object as indirection instead of instantiating a generic for a great number of type parameters. However, these can not be allocated (or often even constructed) directly. The standard library Box usually provides a sort of coercion: You can convert Box<[T; N]> to Box<[T]> for all array sizes or Box<u32> to Box<dyn Any>.

However, this does not work for custom smart pointers. The conversion is based on a nightly-only trait that one needs to explicitly opt-in to. This crate provides an alternative that works with no_std environments, for example to enable custom Box designs that avoid any dependency on a global allocator, or an arena based reference counted pointer, etc. For these use cases it is intended to replace the nightly unsizing mechanism with a stable and safe solution.

Usage

As a library developer you can implement the CoerciblePtr trait for your smart pointer type. This enables the use of all coercions with this pointer type. To provide custom unsize coercions to your own ?Sized wrapper type you can provide a safe constructor for Coercion.

As a user of a unsize-enabled pointer type, you should import the CoerceUnsize extension trait and the Coercion marker type. Then create an instance of Coercion to 'coerce' the pointee type of a smart pointer. The type defines a number of safe constructors and an unsafe escape hatch. The crate further defines a macro that provides safe coercion to other unsized types, if it compiles.

Additional

This project is licensed under Zlib OR Apache-2.0 OR MIT. You may alternatively choose the Unlicense instead in which case the copyright headers signify the parts dedicated to the public domain to the fullest possible extent instead.

No runtime deps