rx

Documentation

Index

• Constants
• Variables
• type Disposable
• type FnFinally
• type FnOnCancel
• type FnOnComplete
• type FnOnError
• type FnOnNext
• type FnOnRequest
• type FnOnSubscribe
• type FnPredicate
• type Publisher
• type RawPublisher
• type SignalType
  • func (s SignalType) String() string
• type Subscriber
  • func NewSubscriber(opts ...SubscriberOption) Subscriber
• type SubscriberOption
  • func OnComplete(onComplete FnOnComplete) SubscriberOption
  • func OnError(onError FnOnError) SubscriberOption
  • func OnNext(onNext FnOnNext) SubscriberOption
  • func OnSubscribe(onSubscribe FnOnSubscribe) SubscriberOption
• type Subscription

Constants

const (
	// SignalComplete indicated that subscriber was completed.
	SignalComplete = SignalType(rs.SignalTypeComplete)
	// SignalCancel indicates that subscriber was cancelled.
	SignalCancel = SignalType(rs.SignalTypeCancel)
	// SignalError indicates that subscriber has some faults.
	SignalError = SignalType(rs.SignalTypeError)
)

const RequestMax = rs.RequestInfinite

Variables

var EmptyRawSubscriber rs.Subscriber

Types

type Disposable

type Disposable interface {
	// Dispose dispose current resource.
	Dispose()
	// IsDisposed returns true if it has been disposed.
	IsDisposed() bool
}

Disposable is a disposable resource.

type FnFinally

type FnFinally = func(s SignalType)

FnFinally is alias of function for signal when all things done.

type FnOnCancel

type FnOnCancel = func()

FnOnCancel is alias of function for signal when subscription canceled.

type FnOnComplete

type FnOnComplete = func()

FnOnComplete is alias of function for signal when no more elements are available

type FnOnError

type FnOnError = func(e error)

FnOnError is alias of function for signal when an error occured.

type FnOnNext

type FnOnNext = func(input payload.Payload)

FnOnNext is alias of function for signal when next element arrived.

type FnOnRequest

type FnOnRequest = func(n int)

FnOnRequest is alias of function for signal when requesting next element.

type FnOnSubscribe

type FnOnSubscribe = func(s Subscription)

FnOnSubscribe is alias of function for signal when subscribe begin.

type FnPredicate

type FnPredicate = func(input payload.Payload) bool

FnPredicate is alias of function for filter operations.

type Publisher

type Publisher interface {
	RawPublisher
	// Subscribe subscribe elements from a publisher, returns a Disposable.
	// You can add some custome options.
	// Using `OnSubscribe`, `OnNext`, `OnComplete` and `OnError` as handler wrapper.
	Subscribe(ctx context.Context, options ...SubscriberOption)
}

Publisher is a provider of a potentially unbounded number of sequenced elements, \ publishing them according to the demand received from its Subscriber(s).

type RawPublisher

type RawPublisher interface {
	SubscribeWith(ctx context.Context, s Subscriber)
}

type SignalType

type SignalType rs.SignalType

SignalType is the signal of reactive events like `OnNext`, `OnComplete`, `OnCancel` and `OnError`.

func (SignalType) String

func (s SignalType) String() string

type Subscriber

type Subscriber interface {
	OnNext(payload payload.Payload)
	OnError(error)
	OnComplete()
	OnSubscribe(Subscription)
}

var EmptySubscriber Subscriber

func NewSubscriber

func NewSubscriber(opts ...SubscriberOption) Subscriber

type SubscriberOption

type SubscriberOption func(*subscriber)

func OnComplete

func OnComplete(onComplete FnOnComplete) SubscriberOption

func OnError

func OnError(onError FnOnError) SubscriberOption

func OnNext

func OnNext(onNext FnOnNext) SubscriberOption

func OnSubscribe

func OnSubscribe(onSubscribe FnOnSubscribe) SubscriberOption

type Subscription

type Subscription rs.Subscription