dotnetrawfilereader_sys/lib.rs
1//! This crate wraps the `librawfilereader` .NET library and its associated dependencies,
2//! manages the creation of a hosted .NET runtime for them, and provides access to the
3//! runtime. See [`thermorawfilereader`](../thermorawfilereader) for useful bindings.
4//!
5//! For regular use, call [`get_runtime`] to get a runtime handle, or [`set_runtime_dir`] to
6//! pre-specify the location where runtime files need to be cached. Alternatively, set the
7//! `DOTNET_RAWFILEREADER_BUNDLE_PATH` environment variable.
8//!
9//! If you wish to link with a local `nethost` library instead of downloading the latest version
10//! at build time, please see [`netcorehost`]'s documentation. This is still distinct from actually
11//! statically linking with .NET's `coreclr` library which must be installed separately.
12//!
13//! # Licensing
14//! By using this library, you agree to the [RawFileReader License](https://github.com/thermofisherlsms/RawFileReader/blob/main/License.doc)
15mod runtime;
16mod buffer;
17
18pub use crate::buffer::{RawVec, configure_allocator};
19pub use crate::runtime::{BundleStore, DotNetLibraryBundle, get_runtime, try_get_runtime, set_runtime_dir, DotNetRuntimeCreationError};