Crate netcorehost

source ·
Expand description

A Rust library for hosting the .NET Core runtime.

It utilizes the .NET Core hosting API to load and execute managed code from withing the current process.

§Usage

§Running an application

The example below will setup the runtime, load Test.dll and run its Main method:

let hostfxr = nethost::load_hostfxr().unwrap();
let context = hostfxr.initialize_for_dotnet_command_line(common::test_dll_path()).unwrap();
let result = context.run_app().value();

The full example can be found in examples/run-app.

§Calling a managed function

A function pointer to a managed method can be aquired using an AssemblyDelegateLoader. This is only supported for HostfxrContext’s that are initialized using Hostfxr::initialize_for_runtime_config. The runtimeconfig.json is automatically generated for executables, for libraries it is neccessary to add <GenerateRuntimeConfigurationFiles>True</GenerateRuntimeConfigurationFiles> to the projects .csproj file.

§Using the default signature

The default method signature is defined as follows:

public delegate int ComponentEntryPoint(IntPtr args, int sizeBytes);

A method with the default signature (see code below) can be loaded using AssemblyDelegateLoader::get_function_with_default_signature.

C#

using System;

namespace Test {
    public static class Program {
        public static int Hello(IntPtr args, int sizeBytes) {
            Console.WriteLine("Hello from C#!");
            return 42;
        }
    }
}

Rust

let hostfxr = nethost::load_hostfxr().unwrap();
let context =
    hostfxr.initialize_for_runtime_config(common::test_runtime_config_path()).unwrap();
let fn_loader =
    context.get_delegate_loader_for_assembly(common::test_dll_path()).unwrap();
let hello = fn_loader.get_function_with_default_signature(
    pdcstr!("Test.Program, Test"),
    pdcstr!("Hello"),
).unwrap();
let result = unsafe { hello(std::ptr::null(), 0) };
assert_eq!(result, 42);

§Using UnmanagedCallersOnly

A function pointer to a method annotated with UnmanagedCallersOnly can be loaded without specifying its signature (as these methods cannot be overloaded).

C#

using System;
using System.Runtime.InteropServices;

namespace Test {
    public static class Program {
        [UnmanagedCallersOnly]
        public static void UnmanagedHello() {
            Console.WriteLine("Hello from C#!");
        }
    }
}

Rust

let hostfxr = nethost::load_hostfxr().unwrap();
let context =
    hostfxr.initialize_for_runtime_config(common::test_runtime_config_path()).unwrap();
let fn_loader =
    context.get_delegate_loader_for_assembly(common::test_dll_path()).unwrap();
let hello = fn_loader.get_function_with_unmanaged_callers_only::<fn()>(
    pdcstr!("Test.Program, Test"),
    pdcstr!("UnmanagedHello"),
).unwrap();
hello();

§Specifying the delegate type

Another option is to define a custom delegate type and passing its assembly qualified name to AssemblyDelegateLoader::get_function.

C#

using System;

namespace Test {
    public static class Program {
        public delegate void CustomHelloFunc();
     
        public static void CustomHello() {
            Console.WriteLine("Hello from C#!");
        }
    }
}

Rust

let hostfxr = nethost::load_hostfxr().unwrap();
let context =
    hostfxr.initialize_for_runtime_config(common::test_runtime_config_path()).unwrap();
let fn_loader =
    context.get_delegate_loader_for_assembly(common::test_dll_path()).unwrap();
let hello = fn_loader.get_function::<fn()>(
    pdcstr!("Test.Program, Test"),
    pdcstr!("CustomHello"),
    pdcstr!("Test.Program+CustomHelloFunc, Test")
).unwrap();
hello();

The full examples can be found in examples/call-managed-function.

§Passing complex parameters

Examples for passing non-primitive parameters can be found in examples/passing-parameters.

§Features

  • nethost - Links against nethost and allows for automatic detection of the hostfxr library.
  • download-nethost - Automatically downloads the latest nethost binary from NuGet.

Modules§

  • bindings
    Module for the raw bindings for hostfxr and nethost.
  • error
    Module containing error enums.
  • hostfxr
    Module for abstractions of the hostfxr library.
  • nethost
    Module for abstractions of the nethost library.
  • pdcstring
    Module for a platform dependent c-like string type.

Macros§