netcorehost 0.5.0

A Rust library for hosting .NET Core applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

#![feature(
    maybe_uninit_uninit_array,
    maybe_uninit_extra,
    maybe_uninit_slice,
    negative_impls
)]
#![allow(clippy::missing_safety_doc)]
#![warn(unsafe_op_in_unsafe_fn)]

//! A Rust library for hosting .NET Core application.
//!
//! This crate allows a .NET Core app to be run inside the current process or to load it and call a contained method directly.
//!
//! # Basic Usage
//! The first step is to load the hostfxr library with handles the hosting. This can be done with [`nethost::load_hostfxr()`]
//! which automatically locates the library on your system. The returned instance of [`Hostfxr`] can then be used to initialize
//! a new [`HostfxrContext`] through one of the `initialize_*` methods like [`initialize_for_dotnet_command_line`]
//! which in turn be used to run the app associated with the context or to load a pointer to a function od the loaded library.
//!
//! # Examples
//! ## Running an application
//! Assuming the following app located inside the current folder and named `Test.dll`:
//! ```cs
//! public static class Program {
//!     public static int Main() {
//!         System.Console.WriteLine("Hello from C#!");
//!     }
//! }
//! ```
//! The following code will setup the hostfxr library, load the app and run its `Main` method.
//! ```
//! # use netcorehost::{nethost, hostfxr::HostExitCode, pdcstr};
//! # use std::path::Path;
//! # use std::str::FromStr;
//! # fn run_app() -> Result<(), Box<dyn std::error::Error>> {
//! let hostfxr = nethost::load_hostfxr()?;
//! let context = hostfxr.initialize_for_dotnet_command_line(pdcstr!("Test.dll"))?;
//! let result = context.run_app();
//! # assert_eq!(result, HostExitCode::from(42));
//! # Ok(())
//! # }
//! ```
//! ## Calling a managed function
//! Assuming the following app located inside the current folder and named `Test.dll`:
//! ```cs
//! namespace Test {
//!     public static class Program {
//!         public static int Hello(IntPtr arg, int argLength) {
//!             return 42;
//!         }
//!     }
//! }
//! ```
//! The following code will setup the hostfxr library, load the app and call the `Hello` method.
//! The method has the default signature which avoids having to specify it. It accepts a ptr to some data and the size of said data.
//! ```
//! # use std::{path::Path, ptr};
//! #
//! # use netcorehost::{nethost, pdcstr};
//! # use std::str::FromStr;
//! #
//! # fn hello_world() -> Result<(), Box<dyn std::error::Error>> {
//! let hostfxr = nethost::load_hostfxr()?;
//! let context =
//!     hostfxr.initialize_for_runtime_config(pdcstr!("Test.runtimeconfig.json"))?;
//! let mut fn_loader =
//!     context.get_delegate_loader_for_assembly(pdcstr!("Test.dll"))?;
//! let hello = fn_loader.get_function_pointer_with_default_signature(
//!     pdcstr!("Test.Program, Test"),
//!     pdcstr!("Hello"),
//! )?;
//! let result = unsafe { hello(ptr::null(), 0) };
//! # assert_eq!(result, 42);
//! #
//! #  Ok(())
//! # }
//! ```
//!
//! Alternatively it is possible to call a method with any signature if it is annotated with [`UnmanagedCallersOnly`] (loaded with
//! [`get_function_pointer_for_unmanaged_callers_only_method`]) or if the signature is passed to [`get_function_pointer`].
//!
//! [`Hostfxr`]: crate::hostfxr::Hostfxr
//! [`HostfxrContext`]: crate::hostfxr::HostfxrContext
//! [`initialize_for_dotnet_command_line`]: crate::hostfxr::Hostfxr::initialize_for_dotnet_command_line
//! [`UnmanagedCallersOnly`]: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute
//! [`get_function_pointer_for_unmanaged_callers_only_method`]: crate::hostfxr::AssemblyDelegateLoader::get_function_pointer_for_unmanaged_callers_only_method
//! [`get_function_pointer`]: crate::hostfxr::AssemblyDelegateLoader::get_function_pointer

#[macro_use]
extern crate dlopen_derive;
#[macro_use]
extern crate quick_error;

/// Module for the raw bindings for hostfxr and nethost.
#[allow(non_camel_case_types, dead_code)]
pub mod bindings;
/// Module for abstractions of the hostfxr library.
pub mod hostfxr;
/// Module for abstractions of the nethost library.
pub mod nethost;

/// Module containing a universal error enum for this crate.
mod error;
pub use error::*;

/// Module for a platform dependent c-like string type.
pub mod pdcstring;