README
¶
MergeWith
MergeWith combines multiple Observables into one by merging their emissions. An error from any of the observables will terminate the merged observables.
Example
Merging two streams of ints generated by FromInt. The result will be perfectly interleaved. The Trampoline scheduler used by Println for subscribing together with the specific way FromInt is implemented will create a repeatable (deterministic) test run with ideal merge behavior.
import _ "github.com/reactivego/rx/generic"
Code:
a := FromInt(0, 2, 4)
b := FromInt(1, 3, 5)
a.MergeWith(b).Println()
Output:
0
1
2
3
4
5
Documentation
¶
Overview ¶
MergeWith combines multiple Observables into one by merging their emissions. An error from any of the observables will terminate the merged observables.
Example (Simple) ¶
Merging two streams of ints generated by FromInt. The result will be perfectly interleaved. The Trampoline scheduler used by Println for subscribing together with the specific way FromInt is implemented will create a repeatable (deterministic) test run with ideal merge behavior.
FromInt(0, 2, 4).MergeWith(FromInt(1, 3, 5)).Println()
Output: 0 1 2 3 4 5
Example (Tree) ¶
Merging a tree of observable ints.
o1 := FromInt(0, 4).MergeWith(JustInt(1)).DoOnComplete(func() {
fmt.Println("a")
})
o2 := FromInt(2, 5).MergeWith(JustInt(3)).DoOnComplete(func() {
fmt.Println("b")
})
o1.MergeWith(o2).DoOnComplete(func() {
fmt.Println("c")
}).Println()
Output: 0 1 2 3 4 5 a b c
Index ¶
Examples ¶
Constants ¶
const ErrUnsubscribed = RxError("subscriber unsubscribed")
Unsubscribed is the error returned by wait when the Unsubscribe method is called on the subscription.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IntObserver ¶
IntObserver is a function that gets called whenever the Observable has something to report. The next argument is the item value that is only valid when the done argument is false. When done is true and the err argument is not nil, then the Observable has terminated with an error. When done is true and the err argument is nil, then the Observable has completed normally.
type ObservableInt ¶
type ObservableInt func(IntObserver, Scheduler, Subscriber)
ObservableInt is a function taking an Observer, Scheduler and Subscriber. Calling it will subscribe the Observer to events from the Observable.
func FromInt ¶
func FromInt(slice ...int) ObservableInt
FromInt creates an ObservableInt from multiple int values passed in.
func JustInt ¶
func JustInt(element int) ObservableInt
JustInt creates an ObservableInt that emits a particular item.
func (ObservableInt) AutoUnsubscribe ¶
func (o ObservableInt) AutoUnsubscribe() ObservableInt
AutoUnsubscribe will automatically unsubscribe from the source when it signals it is done. This Operator subscribes to the source Observable using a separate subscriber. When the source observable subsequently signals it is done, the separate subscriber will be Unsubscribed.
func (ObservableInt) DoOnComplete ¶
func (o ObservableInt) DoOnComplete(f func()) ObservableInt
DoOnComplete calls a function when the stream completes.
func (ObservableInt) MergeWith ¶
func (o ObservableInt) MergeWith(other ...ObservableInt) ObservableInt
MergeWith combines multiple Observables into one by merging their emissions. An error from any of the observables will terminate the merged observables.
func (ObservableInt) Println ¶
func (o ObservableInt) Println(a ...interface{}) error
Println subscribes to the Observable and prints every item to os.Stdout while it waits for completion or error. Returns either the error or nil when the Observable completed normally. Println uses a serial scheduler created with NewScheduler().
type Scheduler ¶
Scheduler is used to schedule tasks to support subscribing and observing.
func NewScheduler ¶ added in v0.0.1
func NewScheduler() Scheduler
type Subscriber ¶
type Subscriber interface {
// A Subscriber is also a Subscription.
Subscription
// Add will create and return a new child Subscriber setup in such a way that
// calling Unsubscribe on the parent will also call Unsubscribe on the child.
// Calling the Unsubscribe method on the child will NOT propagate to the
// parent!
Add() Subscriber
// OnUnsubscribe will add the given callback function to the subscriber.
// The callback will be called when either the Unsubscribe of the parent
// or of the subscriber itself is called. If the subscription was already
// canceled, then the callback function will just be called immediately.
OnUnsubscribe(callback func())
// OnWait will register a callback to call when subscription Wait is called.
OnWait(callback func())
// Done will set the error internally and then cancel the subscription by
// calling the Unsubscribe method. A nil value for error indicates success.
Done(err error)
// Error returns the error set by calling the Done(err) method. As long as
// the subscriber is still subscribed Error will return nil.
Error() error
}
Subscriber is a Subscription with management functionality.
func NewSubscriber ¶ added in v0.0.1
func NewSubscriber() Subscriber
New will create and return a new Subscriber.
type Subscription ¶ added in v0.0.1
type Subscription interface {
// Subscribed returns true when the subscription is currently active.
Subscribed() bool
// Unsubscribe will do nothing if the subscription is not active. If the
// state is still active however, it will be changed to canceled.
// Subsequently, it will call Unsubscribe on all child subscriptions added
// through Add, along with all methods added through OnUnsubscribe. When the
// subscription is canceled by calling Unsubscribe a call to the Wait method
// will return the error ErrUnsubscribed.
Unsubscribe()
// Canceled returns true when the subscription state is canceled.
Canceled() bool
// Wait will by default block the calling goroutine and wait for the
// Unsubscribe method to be called on this subscription.
// However, when OnWait was called with a callback wait function it will
// call that instead. Calling Wait on a subscription that has already been
// canceled will return immediately. If the subscriber was canceled by
// calling Unsubscribe, then the error returned is ErrUnsubscribed.
// If the subscriber was terminated by calling Done, then the error
// returned here is the one passed to Done.
Wait() error
}
Subscription is an interface that allows code to monitor and control a subscription it received.
Source Files