Ryder 0.8.0

Minimal .NET Standard library used to redirect calls from one method to another.\n Ryder also exists as a single lightweight .cs file; please see the repository.

Install-Package Ryder -Version 0.8.0
dotnet add package Ryder --version 0.8.0
<PackageReference Include="Ryder" Version="0.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Ryder --version 0.8.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

<p align="center">
<img src="./Ryder/Properties/Icon.png" alt="Ryder">
</p>

<p align="center">
Ryder is a .NET Core library providing the ability to redirect method calls from one method to another. By extension, it can also redirect property accesses, and event subscriptions / raises.
</p>

<p align="center">
<a href="https://nuget.org/packages/Ryder">
<img src="https://img.shields.io/nuget/v/Ryder.svg" alt="NuGet">
</a>
<a href="../../issues">
<img src="https://img.shields.io/github/issues-raw/6A/Ryder.svg" alt="Issues">
</a>
<a href="./LICENSE.md">
<img src="https://img.shields.io/github/license/6A/Ryder.svg" alt="License">
</a>
</p>


Get started

Redirect a method
public static int Incremented(int nbr) => nbr + 1;
public static int Decremented(int nbr) => nbr - 1;

Incremented(1); // => 2.

MethodRedirection r = Redirection.Redirect<Func<int, int>>(Incremented, Decremented);

Incremented(1); // => 0.

// You can also invoke the original method:
r.InvokeOriginal(null, 1); // => 2.

// You can also stop the redirection...
r.Stop(); // or r.IsRedirecting = false, or r.Dispose().
Incremented(1); // => 2.

// ... and restart it
r.Start(); // or r.IsRedirecting = true, unless you disposed it, in which case it's no longer usable
Incremented(1); // => 0.
Using Reactive Extensions
MethodInfo method = typeof(DateTime)
    .GetProperty(nameof(DateTime.Now), BindingFlags.Static | BindingFlags.Public)
    .GetGetMethod();

int count = 0;
DateTime bday = new DateTime(1955, 10, 28);

// Make "DateTime.get_Now()" return "bday" every two calls.
using (Redirection.Observe(method)
                  .Where(_ => count++ % 2 == 0)
                  .Subscribe(ctx => ctx.ReturnValue = bday))
{
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
}

DateTime.Now.ShouldNotBe(bday);
DateTime.Now.ShouldNotBe(bday);
Other features
Any Redirection also defines the following members:
  • bool IsRedirecting { get; set; }
  • void Start()
  • void Stop()
Redirections can be created in multiple ways:
  • MethodRedirection: Redirect(Delegate, Delegate), Redirect(MethodBase, MethodBase).
  • PropertyRedirection: Redirect(PropertyInfo, PropertyInfo).
  • EventRedirection: Redirect(EventInfo, EventInfo).
Tests:

All features are tested in Ryder.Tests. Please check it out, as it contains some real-world-usage code.

Gloriously unsafe:

By default, Ryder performs many safety checks when you create a new Redirection. However, should you decide to do some experimental things, disabling all those checks is as easy as setting the skipChecks parameter available on all Redirect methods to true.

Implicit JIT checks:

When creating a Redirection, Ryder will ensure that the methods you use have already been jitted. If they haven't, they will be compiled automatically.

Support for i386, x86_64, arm and arm64

Ryder is designed to work with i386, x86_64, arm and arm64 using purely runtime checks. This means that it works everywhere
without additional configuration. Additionally, Windows, Linux and OSX are all supported.

Installation

You can install Ryder through the NuGet package manager:

Install-Package Ryder

Alternatively, if you don't want to add a dependency, you can copy-paste the
Ryder.Lightweight.cs file in your project. Caution, however, since this version only
provides the MethodRedirection class (simply called Redirection), and performs no safety checks.

Additional notes

  • Make sure the method you want to redirect does not get inlined by the JIT; if it does get inlined, redirecting it will most likely break stuff in unexpected ways, or do nothing at all. Additionally, if the method you redirect hasn't been jitted yet, the same problems may arise.
  • In order to keep the GC from collecting jitted methods, Ryder keeps static references to them. Those references are only deleted when Redirection.Dispose() is called, after which the Redirection is no longer guaranteed to work.

Inspiration

Ryder is highly inspired by Harmony, but tries
to take a very minimal approach to redirection, instead of providing the ability to patch individual instructions. Moreover, it was made with .NET Core in mind.

Projects using Ryder

<p align="center">
<img src="./Ryder/Properties/Icon.png" alt="Ryder">
</p>

<p align="center">
Ryder is a .NET Core library providing the ability to redirect method calls from one method to another. By extension, it can also redirect property accesses, and event subscriptions / raises.
</p>

<p align="center">
<a href="https://nuget.org/packages/Ryder">
<img src="https://img.shields.io/nuget/v/Ryder.svg" alt="NuGet">
</a>
<a href="../../issues">
<img src="https://img.shields.io/github/issues-raw/6A/Ryder.svg" alt="Issues">
</a>
<a href="./LICENSE.md">
<img src="https://img.shields.io/github/license/6A/Ryder.svg" alt="License">
</a>
</p>


Get started

Redirect a method
public static int Incremented(int nbr) => nbr + 1;
public static int Decremented(int nbr) => nbr - 1;

Incremented(1); // => 2.

MethodRedirection r = Redirection.Redirect<Func<int, int>>(Incremented, Decremented);

Incremented(1); // => 0.

// You can also invoke the original method:
r.InvokeOriginal(null, 1); // => 2.

// You can also stop the redirection...
r.Stop(); // or r.IsRedirecting = false, or r.Dispose().
Incremented(1); // => 2.

// ... and restart it
r.Start(); // or r.IsRedirecting = true, unless you disposed it, in which case it's no longer usable
Incremented(1); // => 0.
Using Reactive Extensions
MethodInfo method = typeof(DateTime)
    .GetProperty(nameof(DateTime.Now), BindingFlags.Static | BindingFlags.Public)
    .GetGetMethod();

int count = 0;
DateTime bday = new DateTime(1955, 10, 28);

// Make "DateTime.get_Now()" return "bday" every two calls.
using (Redirection.Observe(method)
                  .Where(_ => count++ % 2 == 0)
                  .Subscribe(ctx => ctx.ReturnValue = bday))
{
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
    DateTime.Now.ShouldBe(bday);
    DateTime.Now.ShouldNotBe(bday);
}

DateTime.Now.ShouldNotBe(bday);
DateTime.Now.ShouldNotBe(bday);
Other features
Any Redirection also defines the following members:
  • bool IsRedirecting { get; set; }
  • void Start()
  • void Stop()
Redirections can be created in multiple ways:
  • MethodRedirection: Redirect(Delegate, Delegate), Redirect(MethodBase, MethodBase).
  • PropertyRedirection: Redirect(PropertyInfo, PropertyInfo).
  • EventRedirection: Redirect(EventInfo, EventInfo).
Tests:

All features are tested in Ryder.Tests. Please check it out, as it contains some real-world-usage code.

Gloriously unsafe:

By default, Ryder performs many safety checks when you create a new Redirection. However, should you decide to do some experimental things, disabling all those checks is as easy as setting the skipChecks parameter available on all Redirect methods to true.

Implicit JIT checks:

When creating a Redirection, Ryder will ensure that the methods you use have already been jitted. If they haven't, they will be compiled automatically.

Support for i386, x86_64, arm and arm64

Ryder is designed to work with i386, x86_64, arm and arm64 using purely runtime checks. This means that it works everywhere
without additional configuration. Additionally, Windows, Linux and OSX are all supported.

Installation

You can install Ryder through the NuGet package manager:

Install-Package Ryder

Alternatively, if you don't want to add a dependency, you can copy-paste the
Ryder.Lightweight.cs file in your project. Caution, however, since this version only
provides the MethodRedirection class (simply called Redirection), and performs no safety checks.

Additional notes

  • Make sure the method you want to redirect does not get inlined by the JIT; if it does get inlined, redirecting it will most likely break stuff in unexpected ways, or do nothing at all. Additionally, if the method you redirect hasn't been jitted yet, the same problems may arise.
  • In order to keep the GC from collecting jitted methods, Ryder keeps static references to them. Those references are only deleted when Redirection.Dispose() is called, after which the Redirection is no longer guaranteed to work.

Inspiration

Ryder is highly inspired by Harmony, but tries
to take a very minimal approach to redirection, instead of providing the ability to patch individual instructions. Moreover, it was made with .NET Core in mind.

Projects using Ryder

Release Notes

- Added support for .NET Framework 4.5 and .NET Core 2.2.

Version History

Version Downloads Last updated
0.8.0 232 4/8/2019
0.7.0 195 10/7/2018
0.6.0 302 11/9/2017
0.5.2 232 8/10/2017
0.5.1 207 8/7/2017
0.5.0 215 8/3/2017
0.4.1 219 8/2/2017
0.4.0 203 7/31/2017
0.3.5 201 7/31/2017
0.3.4 204 7/31/2017
0.3.3 189 7/31/2017
0.3.2 199 7/27/2017
0.3.1 199 7/27/2017
0.3.0 199 7/27/2017
0.2.0 196 7/26/2017
0.1.0 252 7/24/2017