Documentation
¶
Overview ¶
Single enforces that the observable sends exactly one data item and then completes.
If the observable sends no data before completing or sends more than 1 item before completing, this is reported as an error to the observer.
Example (Single) ¶
Single is used to make sure only a single value was produced by the observable.
// Just output 1 int.
FromInt(19).Single().Subscribe(func(next int, err error, done bool) {
switch {
case !done:
fmt.Println(next)
case err != nil:
fmt.Println(err)
default:
fmt.Println("complete")
}
}).Wait()
// Now output 2 ints.
FromInt(19, 20).Single().Subscribe(func(next int, err error, done bool) {
switch {
case !done:
fmt.Println(next)
case err != nil:
fmt.Println(err)
default:
fmt.Println("complete")
}
}).Wait()
Output: 19 complete expected one value, got multiple
Index ¶
Examples ¶
Constants ¶
const DidNotEmitValue = RxError("expected one value, got none")
const EmittedMultipleValues = RxError("expected one value, got multiple")
const ErrUnsubscribed = RxError("subscriber unsubscribed")
Unsubscribed is the error returned by wait when the Unsubscribe method is called on the subscription.
const TypecastFailed = RxError("typecast failed")
ErrTypecast is delivered to an observer if the generic value cannot be typecast to a specific type.
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 Observable ¶
type Observable func(Observer, Scheduler, Subscriber)
Observable is a function taking an Observer, Scheduler and Subscriber. Calling it will subscribe the Observer to events from the Observable.
func (Observable) AsObservableInt ¶
func (o Observable) AsObservableInt() ObservableInt
AsObservableInt turns an Observable of interface{} into an ObservableInt. If during observing a typecast fails, the error ErrTypecastToInt will be emitted.
func (Observable) Single ¶
func (o Observable) Single() Observable
Single enforces that the observable sends exactly one data item and then completes. If the observable sends no data before completing or sends more than 1 item before completing, this is reported as an error to the observer.
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 (ObservableInt) AsObservable ¶
func (o ObservableInt) AsObservable() Observable
AsObservable turns a typed ObservableInt into an Observable of interface{}.
func (ObservableInt) Single ¶
func (o ObservableInt) Single() ObservableInt
Single enforces that the observableInt sends exactly one data item and then completes. If the observable sends no data before completing or sends more than 1 item before completing this reported as an error to the observer.
func (ObservableInt) Subscribe ¶
func (o ObservableInt) Subscribe(observe IntObserver, schedulers ...Scheduler) Subscription
Subscribe operates upon the emissions and notifications from an Observable. This method returns a Subscription. Subscribe uses a serial scheduler created with NewScheduler().
type Observer ¶
Observer 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 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 ¶
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