mono

Documentation

Index

• func CreateProcessorOneshot() (Mono, Sink)
• func IsSubscribeAsync(m Mono) bool
• type Mono
  • func Create(gen func(context.Context, Sink)) Mono
  • func CreateFromChannel(payloads <-chan payload.Payload, err <-chan error) Mono
  • func CreateOneshot(gen func(context.Context, Sink)) Mono
  • func Empty() Mono
  • func Error(err error) Mono
  • func ErrorOneshot(err error) Mono
  • func Just(input payload.Payload) Mono
  • func JustOneshot(input payload.Payload) Mono
  • func JustOrEmpty(input payload.Payload) Mono
  • func Raw(input mono.Mono) Mono
• type Processor
  • func CreateProcessor() Processor
• type ReleaseFunc
• type Sink

Functions

func CreateProcessorOneshot

func CreateProcessorOneshot() (Mono, Sink)

func IsSubscribeAsync

func IsSubscribeAsync(m Mono) bool

IsSubscribeAsync returns true if target Mono will be subscribed async.

Types

type Mono

type Mono interface {
	rx.Publisher
	// Filter evaluate each source value against the given Predicate.
	// If the predicate test succeeds, the value is emitted.
	Filter(rx.FnPredicate) Mono
	// Map transform the item emitted by this Mono by applying a synchronous function to another.
	Map(rx.FnTransform) Mono
	// FlatMap Transform the item emitted by this Mono asynchronously, returning the value emitted by another Mono.
	FlatMap(func(payload.Payload) Mono) Mono
	// DoFinally adds behavior (side-effect) triggered after the Mono terminates for any reason, including cancellation.
	DoFinally(rx.FnFinally) Mono
	// DoOnError adds behavior (side-effect) triggered when the Mono completes with an error.
	DoOnError(rx.FnOnError) Mono
	// DoOnSuccess adds behavior (side-effect) triggered when the Mono completes with an success.
	DoOnSuccess(rx.FnOnNext) Mono
	// DoOnCancel add behavior (side-effect) triggered when the Mono is cancelled.
	DoOnCancel(rx.FnOnCancel) Mono
	// DoOnSubscribe add behavior (side-effect) triggered when the Mono is done being subscribed.
	DoOnSubscribe(rx.FnOnSubscribe) Mono
	// SubscribeOn customize a Scheduler running Subscribe, OnSubscribe and Request.
	SubscribeOn(scheduler.Scheduler) Mono
	// SubscribeWithChan subscribe to this Mono and puts item/error into channels.
	SubscribeWithChan(ctx context.Context, valueChan chan<- payload.Payload, errChan chan<- error)
	// BlockUnsafe blocks Mono and returns data and error.
	// Payload could be pooled sometimes, so make sure calling ReleaseFunc when you no longer need Payload, or it will cause leak problem.
	BlockUnsafe(context.Context) (payload.Payload, ReleaseFunc, error)
	// Block blocks Mono and returns a cloned payload.
	// It's different from BlockUnsafe, you don't need release it manually.
	Block(context.Context) (payload.Payload, error)
	//SwitchIfEmpty switch to an alternative Publisher if this Mono is completed without any data.
	SwitchIfEmpty(alternative Mono) Mono
	// Raw returns low-level reactor.Mono which defined in reactor-go library.
	Raw() mono.Mono
	// ToChan subscribe Mono and puts items into a chan.
	// It also puts errors into another chan.
	ToChan(ctx context.Context) (c <-chan payload.Payload, e <-chan error)
	// Timeout sets the timeout value.
	Timeout(timeout time.Duration) Mono
}

Mono is a Reactive Streams Publisher with basic rx operators that completes successfully by emitting an element, or with an error.

func Create

func Create(gen func(context.Context, Sink)) Mono

Create wraps a generator function to a Mono.

func CreateFromChannel

func CreateFromChannel(payloads <-chan payload.Payload, err <-chan error) Mono

CreateFromChannel creates a Mono from channels.

func CreateOneshot

func CreateOneshot(gen func(context.Context, Sink)) Mono

CreateOneshot wraps a generator function to an oneshot Mono.

func Empty

func Empty() Mono

Empty returns an empty Mono.

func Error

func Error(err error) Mono

Error wraps an error to a Mono.

func ErrorOneshot

func ErrorOneshot(err error) Mono

ErrorOneshot wraps an error to an oneshot Mono.

func Just

func Just(input payload.Payload) Mono

Just wrap an exist Payload to a Mono.

func JustOneshot

func JustOneshot(input payload.Payload) Mono

JustOneshot wraps an existing Payload to an oneshot Mono.

func JustOrEmpty

func JustOrEmpty(input payload.Payload) Mono

JustOrEmpty wraps an existing Payload to a Mono. Payload could be nil here.

func Raw

func Raw(input mono.Mono) Mono

Raw wrap a low-level Mono.

type Processor

type Processor interface {
	Sink
	Mono
}

Processor combine Sink and Mono.

func CreateProcessor

func CreateProcessor() Processor

CreateProcessor creates a Processor.

type ReleaseFunc

type ReleaseFunc func()

ReleaseFunc can be used to release resources.

type Sink

type Sink interface {
	// Success emits a single value then complete current Sink.
	Success(payload.Payload)
	// Error emits an error then complete current Sink.
	Error(error)
}

Sink is a wrapper API around an actual downstream Subscriber for emitting nothing, a single value or an error (mutually exclusive).