Interface IModule

TBD

Inherited Members

IComparable<IModule>.CompareTo(IModule)

Namespace: Akka.Streams.Implementation

Assembly: Akka.Streams.dll

Syntax

public interface IModule : IComparable<IModule>

Properties

Attributes

TBD

Declaration

Attributes Attributes { get; }

Property Value

Type	Description
Attributes

Downstreams

TBD

Declaration

IImmutableDictionary<OutPort, InPort> Downstreams { get; }

Property Value

Type	Description
IImmutableDictionary<OutPort, InPort>

InPorts

TBD

Declaration

IImmutableSet<InPort> InPorts { get; }

Property Value

Type	Description
IImmutableSet<InPort>

IsAtomic

TBD

Declaration

bool IsAtomic { get; }

Property Value

Type	Description
bool

IsBidiFlow

TBD

Declaration

bool IsBidiFlow { get; }

Property Value

Type	Description
bool

IsCopied

TBD

Declaration

bool IsCopied { get; }

Property Value

Type	Description
bool

IsFlow

TBD

Declaration

bool IsFlow { get; }

Property Value

Type	Description
bool

IsRunnable

TBD

Declaration

bool IsRunnable { get; }

Property Value

Type	Description
bool

IsSealed

TBD

Declaration

bool IsSealed { get; }

Property Value

Type	Description
bool

IsSink

TBD

Declaration

bool IsSink { get; }

Property Value

Type	Description
bool

IsSource

TBD

Declaration

bool IsSource { get; }

Property Value

Type	Description
bool

MaterializedValueComputation

TBD

Declaration

StreamLayout.IMaterializedValueNode MaterializedValueComputation { get; }

Property Value

Type	Description
StreamLayout.IMaterializedValueNode

OutPorts

TBD

Declaration

IImmutableSet<OutPort> OutPorts { get; }

Property Value

Type	Description
IImmutableSet<OutPort>

Shape

TBD

Declaration

Shape Shape { get; }

Property Value

Type	Description
Shape

SubModules

TBD

Declaration

ImmutableArray<IModule> SubModules { get; }

Property Value

Type	Description
ImmutableArray<IModule>

Upstreams

TBD

Declaration

IImmutableDictionary<InPort, OutPort> Upstreams { get; }

Property Value

Type	Description
IImmutableDictionary<InPort, OutPort>

Methods

CarbonCopy()

TBD

Declaration

IModule CarbonCopy()

Returns

Type	Description
IModule	TBD

Compose(IModule)

Creates a new Module which is this Module composed with that Module.

Declaration

IModule Compose(IModule that)

Parameters

Type	Name	Description
IModule	that	A Module to be composed with (cannot be itself)

Returns

Type	Description
IModule	A Module that represents the composition of this and that

ComposeNoMaterialized(IModule)

Creates a new Module which is this Module composed with that Module.

The difference to compose(that) is that this version completely ignores the materialized value computation of that while the normal version executes the computation and discards its result. This means that this version must not be used for user-provided that modules because users may transform materialized values only to achieve some side-effect; it can only be used where we know that there is no meaningful computation to be done (like for MaterializedValueSource).

Declaration

IModule ComposeNoMaterialized(IModule that)

Parameters

Type	Name	Description
IModule	that	a Module to be composed with (cannot be itself)

Returns

Type	Description
IModule	a Module that represents the composition of this and that

Compose<T1, T2, T3>(IModule, Func<T1, T2, T3>)

Creates a new Module which is this Module composed with that Module, using the given function matFunc to compose the materialized value of this with the materialized value of that.

Declaration

IModule Compose<T1, T2, T3>(IModule that, Func<T1, T2, T3> matFunc)

Parameters

Type	Name	Description
IModule	that	A Module to be composed with (cannot be itself)
Func<T1, T2, T3>	matFunc	A function which combines the materialized values

Returns

Type	Description
IModule	A Module that represents the composition of this and that

Type Parameters

Name	Description
T1	The type of the materialized value of this
T2	The type of the materialized value of that
T3	The type of the materialized value of the returned Module

Fuse(IModule, OutPort, InPort)

Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this in the result

Declaration

IModule Fuse(IModule that, OutPort from, InPort to)

Parameters

Type	Name	Description
IModule	that	A module to fuse with
OutPort	from	The data source to wire
InPort	to	The data sink to wire

Returns

Type	Description
IModule	A module representing fusion of this and that

Fuse<T1, T2, T3>(IModule, OutPort, InPort, Func<T1, T2, T3>)

Fuses this Module to that Module by wiring together from and to, retaining the materialized value of this in the result, using the provided function matFunc.

Declaration

IModule Fuse<T1, T2, T3>(IModule that, OutPort from, InPort to, Func<T1, T2, T3> matFunc)

Parameters

Type	Name	Description
IModule	that	A module to fuse with
OutPort	from	The data source to wire
InPort	to	The data sink to wire
Func<T1, T2, T3>	matFunc	The function to apply to the materialized values

Returns

Type	Description
IModule	A module representing fusion of this and that

Type Parameters

Name	Description
T1	TBD
T2	TBD
T3	TBD

Nest()

Creates a new Module which contains this Module

Declaration

IModule Nest()

Returns

Type	Description
IModule	TBD

ReplaceShape(Shape)

Verify that the given Shape has the same ports and return a new module with that shape. Concrete implementations may throw UnsupportedOperationException where applicable.

Declaration

IModule ReplaceShape(Shape shape)

Parameters

Type	Name	Description
Shape	shape	TBD

Returns

Type	Description
IModule	TBD

TransformMaterializedValue<TMat, TMat2>(Func<TMat, TMat2>)

TBD

Declaration

IModule TransformMaterializedValue<TMat, TMat2>(Func<TMat, TMat2> mapFunc)

Parameters

Type	Name	Description
Func<TMat, TMat2>	mapFunc	TBD

Returns

Type	Description
IModule	TBD

Type Parameters

Name	Description
TMat	TBD
TMat2	TBD

Wire(OutPort, InPort)

Creates a new Module based on the current Module but with the given OutPort wired to the given InPort.

Declaration

IModule Wire(OutPort from, InPort to)

Parameters

Type	Name	Description
OutPort	from	The OutPort to wire.
InPort	to	The InPort to wire.

Returns

Type	Description
IModule	A new Module with the ports wired

WithAttributes(Attributes)

TBD

Declaration

IModule WithAttributes(Attributes attributes)

Parameters

Type	Name	Description
Attributes	attributes	TBD

Returns

Type	Description
IModule	TBD

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)