multicast-delegate 1.0.1
C-Sharp style MulticastDelegate, allows combining and calling multiple delegates into one
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
multicast-delegate
C-Sharp style MulticastDelegate, allows combining and calling multiple delegates
into one. Transparently works with third party libraries, works with @safe
,
nothrow
, pure
and has APIs to use with @nogc
. The library works well with
const
and immutable
as well and the data structure is simply a safe and
efficient wrapper around delegate arrays. Offers consistent D-style operator
overloading using the ~
concatenation operator as well as C# compatible +
and -
operators for calling the add and remove functions.
- Allows you to define APIs with more flexible callbacks
- Allows you to use this as C# style event system
- Allows you to write arbitrary depth callbacks with return values and out/ref
- Uses idiomatic features with full integration of language features
To use in your dub project simply run
dub add multicast-delegate
To use with additional C# compatibility types, add
"subConfigurations": {
"multicast-delegate": "cs-compat"
}
to your dub.json or add
// dub.sdl
subConfiguration "multicast-delegate" "cs-compat"
to your dub.sdl.
To use elsewhere, just copy the
source/multicast_delegate.d file into your
project and import it using import multicast_delegate
.
Example
import std.stdio;
import multicast_delegate; // I recommend using `public import` for all
// your common imports in some helper file
// have documented delegate types for your callbacks
alias SomeDelegate = void delegate();
// define your APIs as usual
void runCallback(SomeDelegate dg) { dg(); }
void main() {
void func1() { writeln("1"); }
void func2() { writeln("2"); }
writeln("\ncalling normal delegate");
// call like normal
runCallback(&func1);
writeln("\ncalling multicast delegates");
// or call with multiple delegates in a row
runCallback(multicast(&func1, &func2));
writeln("\ncalling more delegates");
// or store more complex delegate groups
Multicast!SomeDelegate multi = &func1;
// mutate it!
multi ~= &func2;
// or construct it immutable or const
immutable Multicast!SomeDelegate fixed = multicast(&func2, &func2);
// concat multiple and call a normal delegate method
runCallback(multi ~ fixed); // implicitly using Multicast!T as delegate
}
outputs
calling normal delegate
1
calling multicast delegates
1
2
calling more delegates
1
2
2
2
Another simple example porting the following C# code:
using System;
public class Program
{
public delegate void SomeDelegate();
public static void Main()
{
void Foo() { Console.WriteLine("foo"); }
void Bar() { Console.WriteLine("bar"); }
SomeDelegate dg = Foo;
dg += Foo;
dg += Foo;
dg += Bar;
dg();
CallCB(dg);
}
public static void CallCB(SomeDelegate cb)
{
cb();
}
}
is ported:
import std.stdio;
import multicast_delegate;
alias SomeDelegate = void delegate();
void main()
{
void foo() { writeln("foo"); }
void bar() { writeln("bar"); }
Multicast!SomeDelegate dg = &foo;
dg ~= &foo;
dg ~= &foo;
dg ~= &bar;
dg();
callCB(dg);
}
void callCB(SomeDelegate cb)
{
cb();
}
If you want to use global functions (not delegates) you need to
import std.functional : toDelegate
and use dg ~= toDelegate(&foo);
or you can define SomeDelegate
as a void function()
. However in this exact
code the callCB function argument would break with that.
Using class or struct members and lambdas works without issues.
Documentation
- 1.0.1 released 4 years ago
- WebFreak001/multicast-delegate
- public domain
- Copyright © 2020, webfeak
- Authors:
- Dependencies:
- none
- Versions:
-
1.0.1 2020-May-20 1.0.0 2020-May-20 ~master 2020-May-20 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
1 downloads this month
-
10 downloads total
-
- Score:
- 0.8
- Short URL:
- multicast-delegate.dub.pm