 | SourceTOut, TMat Class |
A SourceTOut, TMat is a set of stream processing steps that has one open output. It can comprise
any number of internal sources and transformations that are wired together, or it can be
an "atomic" source, e.g. from a collection or a file. Materialization turns a Source into
a Reactive Streams IPublisher (at least conceptually).
Inheritance HierarchyNamespace: Akka.Streams.Dsl
Assembly: Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntaxpublic sealed class Source<TOut, TMat> : IFlow<TOut, TMat>, IGraph<SourceShape<TOut>, TMat>, IGraph<SourceShape<TOut>>
Type Parameters
- TOut
- TBD
- TMat
- TBD
The SourceTOut, TMat type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SourceTOut, TMat |
TBD
|
Properties
Methods| Name | Description | |
|---|---|---|
| AddAttributes |
Add the given attributes to this SourceTOut, TMat.
Further calls to WithAttributes(Attributes)
will not remove these attributes. Note that this
operation has no effect on an empty Flow (because the attributes apply
only to the contained processing stages).
|
| Async |
Put an asynchronous boundary around this Source.
|
| CombineT, TOut2 |
Combines several sources with fun-in strategy like MergeTIn, TOut or ConcatTIn, TOut and returns SourceTOut, TMat.
|
| ConcatMaterializedTMat2, TMat3 |
Concatenate the given SourceTOut, TMat to this FlowTIn, TOut, TMat, meaning that once this
Flow’s input is exhausted and all result elements have been generated,
the Source’s elements will be produced.
Note that the SourceTOut, TMat is materialized together with this Flow and just kept
from producing elements by asserting back-pressure until its time comes.
If this FlowTIn, TOut, TMat gets upstream error - no elements from the given SourceTOut, TMat will be pulled.
@see ConcatTIn, TOut.
It is recommended to use the internally optimized LeftTLeft, TRight(TLeft, TRight) and RightTLeft, TRight(TLeft, TRight) combiners
where appropriate instead of manually writing functions that pass through one of the values.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MapMaterializedValueTMat2 |
Transform only the materialized value of this Source, leaving all other properties as they were.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Named |
Add a name attribute to this Source.
|
| RunAggregateTOut2 |
Shortcut for running this SourceTOut, TMat with a fold function.
The given function is invoked for every received element, giving it its previous
output (or the given zero value) and the element as input.
The returned TaskTResult will be completed with value of the final
function evaluation when the input stream ends, or completed with Failure
if there is a failure signaled in the stream.
|
| RunAggregateAsyncTOut2 |
Shortcut for running this SourceTOut, TMat with a async aggregate function.
The given function is invoked for every received element, giving it its previous
output (or the given zero value) and the element as input.
The returned TaskTResult will be completed with value of the final
function evaluation when the input stream ends, or completed with Failure
if there is a failure signaled in the stream.
|
| RunForeach |
Shortcut for running this SourceTOut, TMat with a foreach procedure. The given procedure is invoked
for each received element.
The returned Task will be completed with Success when reaching the
normal end of the stream, or completed with Failure if there is a failure signaled in
the stream.
|
| RunSum |
Shortcut for running this SourceTOut, TMat with a reduce function.
The given function is invoked for every received element, giving it its previous
output (from the second element) and the element as input.
The returned TaskTResult will be completed with value of the final
function evaluation when the input stream ends, or completed with Failure
if there is a failure signaled in the stream.
|
| RunWithTMat2 |
Connect this SourceTOut, TMat to a SinkTIn, TMat and run it. The returned value is the materialized value
of the SinkTIn, TMat , e.g. the IPublisher of a PublisherTIn.
|
| ToTMat2 |
Connect this SourceTOut, TMat to a SinkTIn, TMat,
concatenating the processing steps of both.
|
| ToMaterializedTMat2, TMat3 |
Connect this SourceTOut, TMat to a SinkTIn, TMat,
concatenating the processing steps of both.
|
| ToString |
TBD
(Overrides ObjectToString.) |
| ViaT2, TMat2 |
Transform this SourceTOut, TMat by appending the given processing steps.
The materialized value of the combined SourceTOut, TMat will be the materialized
value of the current flow (ignoring the other flow’s value), use
ViaMaterializedTOut2, TMat2, TMat3(IGraphFlowShapeTOut, TOut2, TMat2, FuncTMat, TMat2, TMat3) if a different strategy is needed.
|
| ViaMaterializedTOut2, TMat2, TMat3 |
Transform this SourceTOut, TMat by appending the given processing steps.
The combine function is used to compose the materialized values of this flow and that
flow into the materialized value of the resulting Flow.
|
| WithAttributes |
Nests the current Source and returns a Source with the given Attributes
|
| ZipNT |
Combine the elements of multiple streams into a stream of lists.
|
| ZipWithNT, TOut2 |
Combine the elements of multiple streams into a stream of sequences using a combiner function.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also