libloading/
changelog.rs

1//! Project changelog
2
3/// Release 0.6.0 (2020-04-05)
4///
5/// * Introduced a new method [`os::unix::Library::get_singlethreaded`];
6/// * Added (untested) support for building when targetting Redox and Fuchsia;
7/// * The APIs exposed by this library no longer panic and instead return an `Err` when it used
8///   to panic.
9///
10/// ## Breaking changes
11///
12/// * Minimum required (stable) version of Rust to build this library is now 1.40.0;
13/// * This crate now implements a custom [`Error`] type and all APIs now return this type rather
14///   than returning the `std::io::Error`;
15/// * `libloading::Result` has been removed;
16/// * Removed the dependency on the C compiler to build this library on UNIX-like platforms.
17///   `libloading` used to utilize a snippet written in C to work-around the unlikely possibility
18///   of the target having a thread-unsafe implementation of the `dlerror` function. The effect of
19///   the work-around was very opportunistic: it would not work if the function was called by
20///   forgoing `libloading`.
21///
22///   Starting with 0.6.0, [`Library::get`] on platforms where `dlerror` is not MT-safe (such as
23///   FreeBSD, DragonflyBSD or NetBSD) will unconditionally return an error when the underlying
24///   `dlsym` returns a null pointer. For the use-cases where loading null pointers is necessary
25///   consider using [`os::unix::Library::get_singlethreaded`] instead.
26///
27/// [`Library::get`]: crate::Library::get
28/// [`os::unix::Library::get_singlethreaded`]: crate::os::unix::Library::get_singlethreaded
29/// [`Error`]: crate::Error
30pub mod r0_6_0 {}
31
32
33/// Release 0.5.2 (2019-07-07)
34///
35/// * Added API to convert OS-specific `Library` and `Symbol` conversion to underlying resources.
36pub mod r0_5_2 {}
37
38/// Release 0.5.1 (2019-06-01)
39///
40/// * Build on Haiku targets.
41pub mod r0_5_1 {}
42
43/// Release 0.5.0 (2018-01-11)
44///
45/// * Update to `winapi = ^0.3`;
46///
47/// ## Breaking changes
48///
49/// * libloading now requires a C compiler to build on UNIX;
50///   * This is a temporary measure until the [`linkage`] attribute is stabilised;
51///   * Necessary to resolve [#32].
52///
53/// [`linkage`]: https://github.com/rust-lang/rust/issues/29603
54/// [#32]: https://github.com/nagisa/rust_libloading/issues/32
55pub mod r0_5_0 {}
56
57/// Release 0.4.3 (2017-12-07)
58///
59/// * Bump lazy-static dependency to `^1.0`;
60/// * `cargo test --release` now works when testing libloading.
61pub mod r0_4_3 {}
62
63
64/// Release 0.4.2 (2017-09-24)
65///
66/// * Improved error and race-condition handling on Windows;
67/// * Improved documentation about thread-safety of Library;
68/// * Added `Symbol::<Option<T>::lift_option() -> Option<Symbol<T>>` convenience method.
69pub mod r0_4_2 {}
70
71
72/// Release 0.4.1 (2017-08-29)
73///
74/// * Solaris support
75pub mod r0_4_1 {}
76
77/// Release 0.4.0 (2017-05-01)
78///
79/// * Remove build-time dependency on target_build_utils (and by extension serde/phf);
80/// * Require at least version 1.14.0 of rustc to build;
81///   * Actually, it is cargo which has to be more recent here. The one shipped with rustc 1.14.0
82///     is what’s being required from now on.
83pub mod r0_4_0 {}
84
85/// Release 0.3.4 (2017-03-25)
86///
87/// * Remove rogue println!
88pub mod r0_3_4 {}
89
90/// Release 0.3.3 (2017-03-25)
91///
92/// * Panics when `Library::get` is called for incompatibly sized type such as named function
93///   types (which are zero-sized).
94pub mod r0_3_3 {}
95
96/// Release 0.3.2 (2017-02-10)
97///
98/// * Minimum version required is now rustc 1.12.0;
99/// * Updated dependency versions (most notably target_build_utils to 0.3.0)
100pub mod r0_3_2 {}
101
102/// Release 0.3.1 (2016-10-01)
103///
104/// * `Symbol<T>` and `os::*::Symbol<T>` now implement `Send` where `T: Send`;
105/// * `Symbol<T>` and `os::*::Symbol<T>` now implement `Sync` where `T: Sync`;
106/// * `Library` and `os::*::Library` now implement `Sync` (they were `Send` in 0.3.0 already).
107pub mod r0_3_1 {}
108
109/// Release 0.3.0 (2016-07-27)
110///
111/// * Greatly improved documentation, especially around platform-specific behaviours;
112/// * Improved test suite by building our own library to test against;
113/// * All `Library`-ies now implement `Send`.
114/// * Added `impl From<os::platform::Library> for Library` and `impl From<Library> for
115/// os::platform::Library` allowing wrapping and extracting the platform-specific library handle;
116/// * Added methods to wrap (`Symbol::from_raw`) and unwrap (`Symbol::into_raw`) the safe `Symbol`
117/// wrapper into unsafe `os::platform::Symbol`.
118///
119/// The last two additions focus on not restricting potential usecases of this library, allowing
120/// users of the library to circumvent safety checks if need be.
121///
122/// ## Breaking Changes
123///
124/// `Library::new` defaults to `RTLD_NOW` instead of `RTLD_LAZY` on UNIX for more consistent
125/// cross-platform behaviour. If a library loaded with `Library::new` had any linking errors, but
126/// unresolved references weren’t forced to be resolved, the library would’ve “just worked”,
127/// whereas now the call to `Library::new` will return an error signifying presence of such error.
128///
129/// ## os::platform
130/// * Added `os::unix::Library::open` which allows specifying arbitrary flags (e.g. `RTLD_LAZY`);
131/// * Added `os::windows::Library::get_ordinal` which allows finding a function or variable by its
132/// ordinal number;
133pub mod r0_3_0 {}