diff --git a/dev/actors/about/index.html b/dev/actors/about/index.html index 28fcd2cb0..eb473da1b 100644 --- a/dev/actors/about/index.html +++ b/dev/actors/about/index.html @@ -69,4 +69,4 @@ # Logs # 1 # 2 -# 3 +# 3 diff --git a/dev/actors/types/buffer/index.html b/dev/actors/types/buffer/index.html index 12c95f5a7..3cd8020eb 100644 --- a/dev/actors/types/buffer/index.html +++ b/dev/actors/types/buffer/index.html @@ -14,4 +14,4 @@ show(getvalues(actor)) # output -[1, 2, 3]

See also: Actor, buffer

source +[1, 2, 3]

See also: Actor, buffer

source diff --git a/dev/actors/types/circularkeep/index.html b/dev/actors/types/circularkeep/index.html index 56c103e41..1c0fe61cf 100644 --- a/dev/actors/types/circularkeep/index.html +++ b/dev/actors/types/circularkeep/index.html @@ -14,4 +14,4 @@ show(getvalues(actor)) # output -[3, 4, 5]

See also: Actor, keep, circularkeep

source +[3, 4, 5]

See also: Actor, keep, circularkeep

source diff --git a/dev/actors/types/function/index.html b/dev/actors/types/function/index.html index cce25b44f..665a9590e 100644 --- a/dev/actors/types/function/index.html +++ b/dev/actors/types/function/index.html @@ -10,4 +10,4 @@ 2 3 4 -5

See also: Actor, subscribe!

source +5

See also: Actor, subscribe!

source diff --git a/dev/actors/types/keep/index.html b/dev/actors/types/keep/index.html index de38beadb..a8f014730 100644 --- a/dev/actors/types/keep/index.html +++ b/dev/actors/types/keep/index.html @@ -14,4 +14,4 @@ show(getvalues(actor)) # output -[1, 2, 3, 4, 5]

See also: Actor, keep

source +[1, 2, 3, 4, 5]

See also: Actor, keep

source diff --git a/dev/actors/types/lambda/index.html b/dev/actors/types/lambda/index.html index 162dfef22..6f023ad8f 100644 --- a/dev/actors/types/lambda/index.html +++ b/dev/actors/types/lambda/index.html @@ -6,4 +6,4 @@ actor isa LambdaActor{Int} # output -true

See also: LambdaActor, AbstractActor

source
Rocket.LambdaActorType
LambdaActor{D, N, E, C}(on_next::N, on_error::E, on_complete::C) where D

Lambda actor wraps on_next, on_error, on_complete callbacks for data, error and complete events. Should not be used explicitly, use lambda creation operator instead.

Constructor arguments

  • on_next: Callback for data event. Optional. Default is nothing.
  • on_error: Callback for error event. Optional. Default is nothing.
  • on_complete: Callback for complete event. Optional. Default is nothing.

See also: Actor, lambda

source
+true

See also: LambdaActor, AbstractActor

source
Rocket.LambdaActorType
LambdaActor{D, N, E, C}(on_next::N, on_error::E, on_complete::C) where D

Lambda actor wraps on_next, on_error, on_complete callbacks for data, error and complete events. Should not be used explicitly, use lambda creation operator instead.

Constructor arguments

  • on_next: Callback for data event. Optional. Default is nothing.
  • on_error: Callback for error event. Optional. Default is nothing.
  • on_complete: Callback for complete event. Optional. Default is nothing.

See also: Actor, lambda

source
diff --git a/dev/actors/types/logger/index.html b/dev/actors/types/logger/index.html index 15e6a450a..450133a89 100644 --- a/dev/actors/types/logger/index.html +++ b/dev/actors/types/logger/index.html @@ -36,4 +36,4 @@ [CustomBuffer] Data: 0 [CustomBuffer] Data: 1 [CustomBuffer] Data: 2 -[CustomBuffer] Completed

See also: LoggerActor, AbstractActor

source
Rocket.LoggerActorType
LoggerActor{D}(name::String = "LogActor", io::O) where { D, O }

The LoggerActor logs all next!/error!/complete! events that are sent from an Observable.

Constructor arguments

  • name: name of the logger. Optional. Default is LogActor.
  • io: io stream to log in, maybe nothing to write to stdout

See also: Actor, logger

source
+[CustomBuffer] Completed

See also: LoggerActor, AbstractActor

source
Rocket.LoggerActorType
LoggerActor{D}(name::String = "LogActor", io::O) where { D, O }

The LoggerActor logs all next!/error!/complete! events that are sent from an Observable.

Constructor arguments

  • name: name of the logger. Optional. Default is LogActor.
  • io: io stream to log in, maybe nothing to write to stdout

See also: Actor, logger

source
diff --git a/dev/actors/types/server/index.html b/dev/actors/types/server/index.html index e4b5481fd..b7d717439 100644 --- a/dev/actors/types/server/index.html +++ b/dev/actors/types/server/index.html @@ -2,4 +2,4 @@ Server · Rocket.jl

Server actor

Rocket.serverFunction
server(port::Int)
 server(address::A, port::Int) where { A <: IPAddr }
 server(::Type{D}, port::Int)
-server(::Type{D}, address::A, port::Int) where { A <: IPAddr }

Creation operator for the ServerActor actor.

See also: AbstractActor

source
Rocket.ServerActorType
ServerActor{D, Address, Port}() where D

The ServerActor sends all next!/error!/complete! events to the local network listeners with specified Address and Port parameters via TCPSocket.

See also: Actor, server

source
+server(::Type{D}, address::A, port::Int) where { A <: IPAddr }

Creation operator for the ServerActor actor.

See also: AbstractActor

source
Rocket.ServerActorType
ServerActor{D, Address, Port}() where D

The ServerActor sends all next!/error!/complete! events to the local network listeners with specified Address and Port parameters via TCPSocket.

See also: Actor, server

source
diff --git a/dev/actors/types/storage/index.html b/dev/actors/types/storage/index.html index bfa9b9183..60f0372b6 100644 --- a/dev/actors/types/storage/index.html +++ b/dev/actors/types/storage/index.html @@ -14,4 +14,4 @@ show(getvalues(actor)) # output -5

See also: Actor, storage

source +5

See also: Actor, storage

source diff --git a/dev/actors/types/sync/index.html b/dev/actors/types/sync/index.html index c00c3e8f4..460417760 100644 --- a/dev/actors/types/sync/index.html +++ b/dev/actors/types/sync/index.html @@ -28,4 +28,4 @@ show(values) # output -[0, 1, 2, 3, 4, 5]

See also: SyncActor, AbstractActor

source
Rocket.SyncActorType
SyncActor{T, A}(actor::A; withlock::Bool = true, timeout::Int = -1) where { T, A }

Sync actor provides a synchronized interface to wait for an actor to be notified with a complete event. By default creates a re-entrant lock for synchronizing next!, error! and complete! events.

See also: Actor, sync

source
+[0, 1, 2, 3, 4, 5]

See also: SyncActor, AbstractActor

source
Rocket.SyncActorType
SyncActor{T, A}(actor::A; withlock::Bool = true, timeout::Int = -1) where { T, A }

Sync actor provides a synchronized interface to wait for an actor to be notified with a complete event. By default creates a re-entrant lock for synchronizing next!, error! and complete! events.

See also: Actor, sync

source
diff --git a/dev/actors/types/void/index.html b/dev/actors/types/void/index.html index 0224c476e..cdfee48cb 100644 --- a/dev/actors/types/void/index.html +++ b/dev/actors/types/void/index.html @@ -16,4 +16,4 @@ ; # output -

See also: Actor, void, tap

source +

See also: Actor, void, tap

source diff --git a/dev/api/actors/index.html b/dev/api/actors/index.html index f0dba32e1..79207f43e 100644 --- a/dev/api/actors/index.html +++ b/dev/api/actors/index.html @@ -51,4 +51,4 @@ CompletionActorTrait{String}()

See also: AbstractActor, as_actor, CompletionActorTrait, ActorTrait, on_complete!

source

Events

Rocket.next!Function
next!(actor, data)
 next!(actor, data, scheduler)

This function is used to deliver a "next" event to an actor with some data. Takes optional scheduler object to schedule execution of data delivery.

See also: AbstractActor, on_next!

source
Rocket.error!Function
error!(actor, err)
 error!(actor, err, scheduler)

This function is used to deliver a "error" event to an actor with some err. Takes optional scheduler object to schedule execution of error delivery.

See also: AbstractActor, on_error!

source
Rocket.complete!Function
complete!(actor)
-complete!(actor, scheduler)

This function is used to deliver a "complete" event to an actor. Takes optional scheduler object to schedule execution of complete event delivery.

See also: AbstractActor, on_complete!

source
Rocket.on_next!Function
on_next!(actor, data)

Both Actor and NextActor objects must implement its own method for on_next! function which will be called on "next" event.

See also: Actor, NextActor

source
Rocket.on_error!Function
on_error!(actor, err)

Both Actor and ErrorActor objects must implement its own method for on_error! function which will be called on "error" event.

See also: Actor, ErrorActor

source
Rocket.on_complete!Function
on_complete!(actor)

Both Actor and CompletionActor objects must implement its own method for on_complete! function which will be called on "complete" event.

See also: Actor, CompletionActor

source

Factory

Rocket.AbstractActorFactoryType

Abstract type for all possible actor factories

See also: Actor

source
Rocket.create_actorFunction
create_actor(::Type{L}, factory::F) where { L, F <: AbstractActorFactory }

Actor creator function for a given factory F. Should be implemented explicitly for any AbstractActorFactory object

See also: AbstractActorFactory, MissingCreateActorFactoryImplementationError

source
Rocket.MissingCreateActorFactoryImplementationErrorType

This error will be throw if Julia cannot find specific method of 'create_actor()' function for given actor factory

See also: AbstractActorFactory, create_actor

source

Errors

Rocket.InvalidActorTraitUsageErrorType

This error will be thrown if next!, error! or complete! functions are called with invalid actor object

See also: next!, error!, complete!, InvalidActorTrait

source
Rocket.InconsistentSourceActorDataTypesErrorType

This error will be thrown if next! function is called with inconsistent data type

See also: AbstractActor, Subscribable, next!

source
Rocket.MissingDataArgumentInNextCallType

This error will be thrown if next! function is called without data argument

See also: next!

source
Rocket.MissingErrorArgumentInErrorCallType

This error will be thrown if error! function is called without err argument

See also: error!

source
Rocket.ExtraArgumentInCompleteCallType

This error will be thrown if complete! function is called with extra data/err argument

See also: complete!

source
Rocket.MissingOnNextImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_next!()' function for given actor and data

See also: on_next!

source
Rocket.MissingOnErrorImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_error!()' function for given actor

See also: on_error!

source
Rocket.MissingOnCompleteImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_complete!()' function for given actor and data

See also: on_next!

source
+complete!(actor, scheduler)

This function is used to deliver a "complete" event to an actor. Takes optional scheduler object to schedule execution of complete event delivery.

See also: AbstractActor, on_complete!

source
Rocket.on_next!Function
on_next!(actor, data)

Both Actor and NextActor objects must implement its own method for on_next! function which will be called on "next" event.

See also: Actor, NextActor

source
Rocket.on_error!Function
on_error!(actor, err)

Both Actor and ErrorActor objects must implement its own method for on_error! function which will be called on "error" event.

See also: Actor, ErrorActor

source
Rocket.on_complete!Function
on_complete!(actor)

Both Actor and CompletionActor objects must implement its own method for on_complete! function which will be called on "complete" event.

See also: Actor, CompletionActor

source

Factory

Rocket.AbstractActorFactoryType

Abstract type for all possible actor factories

See also: Actor

source
Rocket.create_actorFunction
create_actor(::Type{L}, factory::F) where { L, F <: AbstractActorFactory }

Actor creator function for a given factory F. Should be implemented explicitly for any AbstractActorFactory object

See also: AbstractActorFactory, MissingCreateActorFactoryImplementationError

source
Rocket.MissingCreateActorFactoryImplementationErrorType

This error will be throw if Julia cannot find specific method of 'create_actor()' function for given actor factory

See also: AbstractActorFactory, create_actor

source

Errors

Rocket.InvalidActorTraitUsageErrorType

This error will be thrown if next!, error! or complete! functions are called with invalid actor object

See also: next!, error!, complete!, InvalidActorTrait

source
Rocket.InconsistentSourceActorDataTypesErrorType

This error will be thrown if next! function is called with inconsistent data type

See also: AbstractActor, Subscribable, next!

source
Rocket.MissingDataArgumentInNextCallType

This error will be thrown if next! function is called without data argument

See also: next!

source
Rocket.MissingErrorArgumentInErrorCallType

This error will be thrown if error! function is called without err argument

See also: error!

source
Rocket.ExtraArgumentInCompleteCallType

This error will be thrown if complete! function is called with extra data/err argument

See also: complete!

source
Rocket.MissingOnNextImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_next!()' function for given actor and data

See also: on_next!

source
Rocket.MissingOnErrorImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_error!()' function for given actor

See also: on_error!

source
Rocket.MissingOnCompleteImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_complete!()' function for given actor and data

See also: on_next!

source
diff --git a/dev/api/observables/index.html b/dev/api/observables/index.html index cf785e7e3..de2db32ba 100644 --- a/dev/api/observables/index.html +++ b/dev/api/observables/index.html @@ -82,4 +82,4 @@ # output [LogActor] Data: 0 -[LogActor] Completed

See also: Subscribable, ScheduledSubscribable, SimpleSubscribableTrait, ScheduledSubscribableTrait, Teardown, logger

source

Errors

Rocket.InvalidSubscribableTraitUsageErrorType

This error will be thrown if subscribe! function is called with invalid subscribable object

See also: subscribe!

source
Rocket.InconsistentActorWithSubscribableDataTypesErrorType

This error will be thrown if subscribe! function is called with inconsistent subscribable and actor objects

See also: subscribe!

source
Rocket.MissingOnSubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_subscribe!()' function for given subscribable and actor

See also: on_subscribe!

source
Rocket.MissingOnScheduledSubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_subscribe!()' function for given subscribable, actor and scheduler

See also: on_subscribe!

source
+[LogActor] Completed

See also: Subscribable, ScheduledSubscribable, SimpleSubscribableTrait, ScheduledSubscribableTrait, Teardown, logger

source

Errors

Rocket.InvalidSubscribableTraitUsageErrorType

This error will be thrown if subscribe! function is called with invalid subscribable object

See also: subscribe!

source
Rocket.InconsistentActorWithSubscribableDataTypesErrorType

This error will be thrown if subscribe! function is called with inconsistent subscribable and actor objects

See also: subscribe!

source
Rocket.MissingOnSubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_subscribe!()' function for given subscribable and actor

See also: on_subscribe!

source
Rocket.MissingOnScheduledSubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of 'on_subscribe!()' function for given subscribable, actor and scheduler

See also: on_subscribe!

source
diff --git a/dev/api/operators/index.html b/dev/api/operators/index.html index c3544c7cf..ab900f660 100644 --- a/dev/api/operators/index.html +++ b/dev/api/operators/index.html @@ -208,4 +208,4 @@ [LogActor] Data: 4 [LogActor] Data: 16 -[LogActor] Completedsource

Errors

Rocket.InvalidOperatorTraitUsageErrorType

This error will be thrown if |> pipe operator is called with invalid operator object

See also: on_call!

source
Rocket.InconsistentSourceOperatorDataTypesErrorType

This error will be thrown if |> pipe operator is called with inconsistent data type

See also: on_call!

source
Rocket.MissingOnCallImplementationErrorType

This error will be thrown if Julia cannot find specific method of on_call! function for a given operator.

See also: on_call!

source
Rocket.MissingOperatorRightImplementationErrorType

This error will be thrown if Julia cannot find specific method of operator_right function for a given operator.

See also: operator_right

source
+[LogActor] Completedsource

Errors

Rocket.InvalidOperatorTraitUsageErrorType

This error will be thrown if |> pipe operator is called with invalid operator object

See also: on_call!

source
Rocket.InconsistentSourceOperatorDataTypesErrorType

This error will be thrown if |> pipe operator is called with inconsistent data type

See also: on_call!

source
Rocket.MissingOnCallImplementationErrorType

This error will be thrown if Julia cannot find specific method of on_call! function for a given operator.

See also: on_call!

source
Rocket.MissingOperatorRightImplementationErrorType

This error will be thrown if Julia cannot find specific method of operator_right function for a given operator.

See also: operator_right

source
diff --git a/dev/api/subjects/index.html b/dev/api/subjects/index.html index ed6914970..2a00ad02e 100644 --- a/dev/api/subjects/index.html +++ b/dev/api/subjects/index.html @@ -1,2 +1,2 @@ -Subjects · Rocket.jl

Subjects API

Traits

Rocket.as_subjectFunction
as_subject(::Type)

This function checks subject trait behavior specification. Should be used explicitly to specify subject trait behavior for any object type.

See also: SubjectTrait

source

Factory

Errors

+Subjects · Rocket.jl

Subjects API

Traits

Rocket.as_subjectFunction
as_subject(::Type)

This function checks subject trait behavior specification. Should be used explicitly to specify subject trait behavior for any object type.

See also: SubjectTrait

source

Factory

Errors

diff --git a/dev/api/teardown/index.html b/dev/api/teardown/index.html index 1cf950c41..b42ef416a 100644 --- a/dev/api/teardown/index.html +++ b/dev/api/teardown/index.html @@ -24,4 +24,4 @@ Unsubscribed!

See also: Teardown, TeardownLogic

source
Rocket.UnsubscribableTeardownLogicType

Unsubscribable teardown logic trait behavior. Unsubscribable teardown object must define its own method for on_unsubscribe!() function which will be invoked when actor decides to unsubscribe! from Observable.

See also: TeardownLogic, on_unsubscribe!, unsubscribe!

source
Rocket.on_unsubscribe!Function
on_unsubscribe!(teardown)

Each valid teardown object with UnsubscribableTeardownLogic trait behavior must implement its own method for on_unsubscribe!() function which will be invoked when actor decides to unsubscribe! from Observable.

See also: Teardown, TeardownLogic, UnsubscribableTeardownLogic

source
Rocket.CallableTeardownLogicType

Callable teardown logic trait behavior. Callable teardown object must be callable (insert meme with a surprised Pikachu here).

See also: TeardownLogic, on_unsubscribe!, unsubscribe!

source
Rocket.VoidTeardownLogicType

Void teardown logic trait behavior. Void teardown object does nothing in unsubscribe! and may not define any additional methods.

See also: TeardownLogic, on_unsubscribe!, unsubscribe!

source
Rocket.InvalidTeardownLogicType

Default teardown logic trait behavour. Invalid teardwon object cannot be used in unsubscribe! function. Doing so will raise an error.

See also: TeardownLogic, on_unsubscribe!, unsubscribe!

source

Types

Rocket.TeardownType

Abstract type for any teardown object. Each teardown object must be a subtype of Teardown.

See also: TeardownLogic

source
Rocket.unsubscribe!Function
unsubscribe!(subscription)
 unsubscribe!(subscriptions::Tuple)
-unsubscribe!(subscriptions::AbstractVector)

unsubscribe! function is used to cancel Observable execution and to dispose any kind of resources used during an Observable execution. If the input argument to the unsubscribe! function is either a tuple or a vector, it will first check that all of the arguments are valid subscription objects and if its true will unsubscribe from each of them individually.

See also: Teardown, TeardownLogic, on_unsubscribe!

source

Errors

Rocket.InvalidTeardownLogicTraitUsageErrorType

This error will be thrown if unsubscribe! function is called with invalid teardown object.

See also: unsubscribe!

source
Rocket.InvalidMultipleTeardownLogicTraitUsageErrorType

This error will be thrown if unsubscribe! function is called with a tuple with invalid teardown object in it.

See also: unsubscribe!

source
Rocket.MissingOnUnsubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of on_unsubscribe!() function for given teardown object.

See also: on_unsubscribe!

source
+unsubscribe!(subscriptions::AbstractVector)

unsubscribe! function is used to cancel Observable execution and to dispose any kind of resources used during an Observable execution. If the input argument to the unsubscribe! function is either a tuple or a vector, it will first check that all of the arguments are valid subscription objects and if its true will unsubscribe from each of them individually.

See also: Teardown, TeardownLogic, on_unsubscribe!

source

Errors

Rocket.InvalidTeardownLogicTraitUsageErrorType

This error will be thrown if unsubscribe! function is called with invalid teardown object.

See also: unsubscribe!

source
Rocket.InvalidMultipleTeardownLogicTraitUsageErrorType

This error will be thrown if unsubscribe! function is called with a tuple with invalid teardown object in it.

See also: unsubscribe!

source
Rocket.MissingOnUnsubscribeImplementationErrorType

This error will be thrown if Julia cannot find specific method of on_unsubscribe!() function for given teardown object.

See also: on_unsubscribe!

source
diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 5105474ad..4fbb7b603 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -1,2 +1,2 @@ -Contributing · Rocket.jl

Contribution guidelines

We welcome all possible contributors. This page details the some of the guidelines that should be followed when contributing to this package.

Reporting bugs

We track bugs using GitHub issues. We encourage you to write complete, specific, reproducible bug reports. Mention the versions of Julia and Rocket.jl for which you observe unexpected behavior. Please provide a concise description of the problem and complement it with code snippets, test cases, screenshots, tracebacks or any other information that you consider relevant. This will help us to replicate the problem and narrow the search space for solutions.

Suggesting features

We welcome new feature proposals. However, before submitting a feature request, consider a few things:

  • Does the feature require changes in the core Rocket.jl code? If it doesn't (for example, you would like to add a operator for a particular application), consider making a separate repository for your extensions.
  • If you would like to add an implementation of a feature that changes a lot in the core Rocket.jl code, please open an issue on GitHub and describe your proposal first. This will allow us to discuss your proposal with you before you invest your time in implementing something that may be difficult to merge later on.

Contributing code

Installing Rocket

We suggest that you use the dev command from the new Julia package manager to install Rocket.jl for development purposes. To work on your fork of Rocket.jl, use your fork's URL address in the dev command, for example:

] dev git@github.com:your_username/Rocket.jl.git

The dev command clones Rocket.jl to ~/.julia/dev/Rocket. All local changes to Rocket code will be reflected in imported code.

Note

It is also might be useful to install Revise.jl package as it allows you to modify code and use the changes without restarting Julia.

Committing code

We use the standard GitHub Flow workflow where all contributions are added through pull requests. In order to contribute, first fork the repository, then commit your contributions to your fork, and then create a pull request on the master branch of the Rocket.jl repository.

Before opening a pull request, please make sure that all tests pass without failing! All demos (can be found in /demo/ directory) have to run without errors as well.

Style conventions

We use default Julia style guide. We list here a few important points and our modifications to the Julia style guide:

  • Use 4 spaces for indentation
  • Type names use UpperCamelCase. For example: ArrayObservable, MapOperator, etc..
  • Function names are lowercase with underscores, when necessary. For example: next!, subscribe!, as_actor, etc..
  • Variable names and function arguments use snake_case
  • The name of a method that modifies its argument(s) must end in !

Unit tests

We use the test-driven development (TDD) methodology for Rocket.jl development. The test coverage should be as complete as possible. Please make sure that you write tests for each piece of code that you want to add.

All unit tests are located in the /test/ directory. The /test/ directory follows the structure of the /src/ directory. Each test file should have following filename format: test_*.jl. Some tests are also present in jldoctest docs annotations directly in the source code. See Julia's documentation about doctests.

The tests can be evaluated by running following command in the Julia REPL:

] test Rocket
+Contributing · Rocket.jl

Contribution guidelines

We welcome all possible contributors. This page details the some of the guidelines that should be followed when contributing to this package.

Reporting bugs

We track bugs using GitHub issues. We encourage you to write complete, specific, reproducible bug reports. Mention the versions of Julia and Rocket.jl for which you observe unexpected behavior. Please provide a concise description of the problem and complement it with code snippets, test cases, screenshots, tracebacks or any other information that you consider relevant. This will help us to replicate the problem and narrow the search space for solutions.

Suggesting features

We welcome new feature proposals. However, before submitting a feature request, consider a few things:

  • Does the feature require changes in the core Rocket.jl code? If it doesn't (for example, you would like to add a operator for a particular application), consider making a separate repository for your extensions.
  • If you would like to add an implementation of a feature that changes a lot in the core Rocket.jl code, please open an issue on GitHub and describe your proposal first. This will allow us to discuss your proposal with you before you invest your time in implementing something that may be difficult to merge later on.

Contributing code

Installing Rocket

We suggest that you use the dev command from the new Julia package manager to install Rocket.jl for development purposes. To work on your fork of Rocket.jl, use your fork's URL address in the dev command, for example:

] dev git@github.com:your_username/Rocket.jl.git

The dev command clones Rocket.jl to ~/.julia/dev/Rocket. All local changes to Rocket code will be reflected in imported code.

Note

It is also might be useful to install Revise.jl package as it allows you to modify code and use the changes without restarting Julia.

Committing code

We use the standard GitHub Flow workflow where all contributions are added through pull requests. In order to contribute, first fork the repository, then commit your contributions to your fork, and then create a pull request on the master branch of the Rocket.jl repository.

Before opening a pull request, please make sure that all tests pass without failing! All demos (can be found in /demo/ directory) have to run without errors as well.

Style conventions

We use default Julia style guide. We list here a few important points and our modifications to the Julia style guide:

  • Use 4 spaces for indentation
  • Type names use UpperCamelCase. For example: ArrayObservable, MapOperator, etc..
  • Function names are lowercase with underscores, when necessary. For example: next!, subscribe!, as_actor, etc..
  • Variable names and function arguments use snake_case
  • The name of a method that modifies its argument(s) must end in !

Unit tests

We use the test-driven development (TDD) methodology for Rocket.jl development. The test coverage should be as complete as possible. Please make sure that you write tests for each piece of code that you want to add.

All unit tests are located in the /test/ directory. The /test/ directory follows the structure of the /src/ directory. Each test file should have following filename format: test_*.jl. Some tests are also present in jldoctest docs annotations directly in the source code. See Julia's documentation about doctests.

The tests can be evaluated by running following command in the Julia REPL:

] test Rocket
diff --git a/dev/getting-started/index.html b/dev/getting-started/index.html index b3373c5e8..e97222e56 100644 --- a/dev/getting-started/index.html +++ b/dev/getting-started/index.html @@ -19,4 +19,4 @@ Rocket.on_error!(actor::StoreActor, error) = doSomethingWithAnError(error) Rocket.on_complete!(actor::StoreActor) = println("Completed: $(actor.values)")

For debugging purposes you can use a general LambdaActor actor or just pass a function object as an actor in subscribe! function..

Operators

What makes Rocket.jl powerful is its ability to help you process, transform and modify the messages that flow through your observables, using Operators.

subscribe!(squared_int_values |> map(Int, (d) -> d ^ 2), lambda(
     on_next = (data) -> println(data)
-))
+)) diff --git a/dev/index.html b/dev/index.html index e175d330e..bad0de023 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · Rocket.jl

Rocket.jl Documentation

Welcome to the documentation for Rocket.jl.

This documentation is an adaptation of the RxJS library documentation.

Table of Contents

Index

+Home · Rocket.jl

Rocket.jl Documentation

Welcome to the documentation for Rocket.jl.

This documentation is an adaptation of the RxJS library documentation.

Table of Contents

Index

diff --git a/dev/observables/about/index.html b/dev/observables/about/index.html index 87de6c5af..6812b4614 100644 --- a/dev/observables/about/index.html +++ b/dev/observables/about/index.html @@ -91,4 +91,4 @@ error!(actor, e) end end -

Disposing Observable Executions

It is common for an Actor to abort execution of an Observable Execution. Once the Actor is done receiving values, it may stop the execution in order to free computation power or memory resources.

When subscribe! is called, the Actor gets attached to the newly created Observable execution. This call also returns an object, the Subscription:

subscription = subscribe!(source, actor)

The Subscription represents the ongoing execution, and has a minimal API that allows you to cancel the execution. Read more about Subscription type here.

With

unsubscribe!(subscription)

you can cancel the ongoing execution.

Note

subscribe! returns a Subscription that represents the ongoing execution. Simply call unsubscribe! on the Subscription to cancel the execution.

+

Disposing Observable Executions

It is common for an Actor to abort execution of an Observable Execution. Once the Actor is done receiving values, it may stop the execution in order to free computation power or memory resources.

When subscribe! is called, the Actor gets attached to the newly created Observable execution. This call also returns an object, the Subscription:

subscription = subscribe!(source, actor)

The Subscription represents the ongoing execution, and has a minimal API that allows you to cancel the execution. Read more about Subscription type here.

With

unsubscribe!(subscription)

you can cancel the ongoing execution.

Note

subscribe! returns a Subscription that represents the ongoing execution. Simply call unsubscribe! on the Subscription to cancel the execution.

diff --git a/dev/observables/types/array/index.html b/dev/observables/types/array/index.html index b62224272..2b42b38b9 100644 --- a/dev/observables/types/array/index.html +++ b/dev/observables/types/array/index.html @@ -56,4 +56,4 @@ [LogActor] Data: d [LogActor] Data: ! [LogActor] Completed -

See also: ArrayObservable, subscribe!, logger, iterable

source
Rocket.ArrayObservableType
ArrayObservable{D, H}(values::Vector{D}, scheduler::H) where { D, H }

ArrayObservable wraps a regular Julia array into an observable. Uses scheduler object to schedule messages delivery.

Constructor arguments

  • values: array of values to be wrapped
  • scheduler: Scheduler-like object

See also: Subscribable, from

source
+

See also: ArrayObservable, subscribe!, logger, iterable

source
Rocket.ArrayObservableType
ArrayObservable{D, H}(values::Vector{D}, scheduler::H) where { D, H }

ArrayObservable wraps a regular Julia array into an observable. Uses scheduler object to schedule messages delivery.

Constructor arguments

  • values: array of values to be wrapped
  • scheduler: Scheduler-like object

See also: Subscribable, from

source
diff --git a/dev/observables/types/collected/index.html b/dev/observables/types/collected/index.html index 0552447b1..69aae99d1 100644 --- a/dev/observables/types/collected/index.html +++ b/dev/observables/types/collected/index.html @@ -11,4 +11,4 @@ [LogActor] Data: [1, 1] [LogActor] Data: [1, 2] -[LogActor] Completed

See also: Subscribable, subscribe!, combineLatest

source

Description

collectLatest collects the values from all Observables in its vector argument. This is done by subscribing to each Observable in order and, whenever an Observable emits, collecting a vector of the most recent values from each Observable (in order). If you pass n Observables to collectLatest, the returned Observable will always emit an ordered vector of n values.

To ensure that the output vector has a consistent length, collectLatest waits for all input Observables to emit at least once before it starts emitting results. This means that if some Observable emits values before other Observables started emitting, all these values but the last will be lost. On the other hand, if some Observable does not emit a value but completes, the resulting Observable will complete simultaneously without emitting anything. Furthermore, if some input Observable does not emit any value and never completes, collectLatest will also never emit and never complete.

If at least one Observable was passed to collectLatest and all passed Observables emitted, then the resulting Observable will complete when all combined streams complete. So even if some Observable completes, the result of collectLatest will still emit values when the other Observables do. In case of a completed Observable, its value will now remain to be the last emitted value. On the other hand, if any Observable errors, collectLatest will also immediately error.

+[LogActor] Completed

See also: Subscribable, subscribe!, combineLatest

source

Description

collectLatest collects the values from all Observables in its vector argument. This is done by subscribing to each Observable in order and, whenever an Observable emits, collecting a vector of the most recent values from each Observable (in order). If you pass n Observables to collectLatest, the returned Observable will always emit an ordered vector of n values.

To ensure that the output vector has a consistent length, collectLatest waits for all input Observables to emit at least once before it starts emitting results. This means that if some Observable emits values before other Observables started emitting, all these values but the last will be lost. On the other hand, if some Observable does not emit a value but completes, the resulting Observable will complete simultaneously without emitting anything. Furthermore, if some input Observable does not emit any value and never completes, collectLatest will also never emit and never complete.

If at least one Observable was passed to collectLatest and all passed Observables emitted, then the resulting Observable will complete when all combined streams complete. So even if some Observable completes, the result of collectLatest will still emit values when the other Observables do. In case of a completed Observable, its value will now remain to be the last emitted value. On the other hand, if any Observable errors, collectLatest will also immediately error.

diff --git a/dev/observables/types/combined/index.html b/dev/observables/types/combined/index.html index 5f5ef91bf..49b84a56b 100644 --- a/dev/observables/types/combined/index.html +++ b/dev/observables/types/combined/index.html @@ -23,4 +23,4 @@ # output [LogActor] Data: (1, 2) -[LogActor] Completed

See also: Subscribable, subscribe!, PushEach, PushEachBut, PushNew, PushNewBut, PushStrategy

source
Rocket.PushEachType
PushEach

PushEach update strategy specifies the strategy to emit new value each time an inner observable emit a new value

See also: combineLatest, PushEachBut, PushNew, PushNewBut, PushStrategy

source
Rocket.PushEachButType
PushEachBut{I}

PushEachBut update strategy specifies the strategy to emit new value if and only if an inner observable with index I have a new value

See also: combineLatest, PushEach, PushNew, PushNewBut, PushStrategy

source
Rocket.PushNewType
PushNew

PushNew update strategy specifies the strategy to emit new value if and only if all inner observables have a new value

See also: combineLatest, PushEach, PushEachBut, PushNewBut, PushStrategy

source
Rocket.PushNewButType
PushNewBut{I}

PushNewBut{I} update strategy specifies the strategy to emit new value if and only if all inner observables except with index I have a new value

See also: combineLatest, PushEach, PushEachBut, PushNew, PushStrategy

source
Rocket.PushStrategyType
PushStrategy(strategy::BitArray{1})

PushStrategy update strategy specifies the strategy to emit new value if and only if all inner observables with index such that strategy[index] = false have a new value

See also: combineLatest, PushEach, PushEachBut, PushNew, PushNewBut, collectLatest

source

Description

combineLatest combines the values from all Observables in its arguments. This is done by subscribing to each Observable in order and, whenever an Observable emits, collecting a tuple of the most recent values from each Observable (in order). If you pass n Observables to combineLatest, the returned Observable will always emit an ordered tuple of n values.

To ensure that the output tuple has a consistent length, combineLatest waits for all input Observables to emit at least once before it starts emitting results. This means that if some Observable emits values before other Observables started emitting, all these values but the last will be lost. On the other hand, if some Observable does not emit a value but completes, the resulting Observable will complete simultaneously without emitting anything. Furthermore, if some input Observable does not emit any value and never completes, combineLatest will also never emit and never complete.

If at least one Observable was passed to combineLatest and all passed Observables emitted, then the resulting Observable will complete when all combined streams complete. So even if some Observable completes, the result of combineLatest will still emit values when the other Observables do. In case of a completed Observable, its value will now remain to be the last emitted value. On the other hand, if any Observable errors, combineLatest will also immediately error.

It is possible to change default update/complete strategy behaviour with an optional strategy object.

+[LogActor] Completed

See also: Subscribable, subscribe!, PushEach, PushEachBut, PushNew, PushNewBut, PushStrategy

source
Rocket.PushEachType
PushEach

PushEach update strategy specifies the strategy to emit new value each time an inner observable emit a new value

See also: combineLatest, PushEachBut, PushNew, PushNewBut, PushStrategy

source
Rocket.PushEachButType
PushEachBut{I}

PushEachBut update strategy specifies the strategy to emit new value if and only if an inner observable with index I have a new value

See also: combineLatest, PushEach, PushNew, PushNewBut, PushStrategy

source
Rocket.PushNewType
PushNew

PushNew update strategy specifies the strategy to emit new value if and only if all inner observables have a new value

See also: combineLatest, PushEach, PushEachBut, PushNewBut, PushStrategy

source
Rocket.PushNewButType
PushNewBut{I}

PushNewBut{I} update strategy specifies the strategy to emit new value if and only if all inner observables except with index I have a new value

See also: combineLatest, PushEach, PushEachBut, PushNew, PushStrategy

source
Rocket.PushStrategyType
PushStrategy(strategy::BitArray{1})

PushStrategy update strategy specifies the strategy to emit new value if and only if all inner observables with index such that strategy[index] = false have a new value

See also: combineLatest, PushEach, PushEachBut, PushNew, PushNewBut, collectLatest

source

Description

combineLatest combines the values from all Observables in its arguments. This is done by subscribing to each Observable in order and, whenever an Observable emits, collecting a tuple of the most recent values from each Observable (in order). If you pass n Observables to combineLatest, the returned Observable will always emit an ordered tuple of n values.

To ensure that the output tuple has a consistent length, combineLatest waits for all input Observables to emit at least once before it starts emitting results. This means that if some Observable emits values before other Observables started emitting, all these values but the last will be lost. On the other hand, if some Observable does not emit a value but completes, the resulting Observable will complete simultaneously without emitting anything. Furthermore, if some input Observable does not emit any value and never completes, combineLatest will also never emit and never complete.

If at least one Observable was passed to combineLatest and all passed Observables emitted, then the resulting Observable will complete when all combined streams complete. So even if some Observable completes, the result of combineLatest will still emit values when the other Observables do. In case of a completed Observable, its value will now remain to be the last emitted value. On the other hand, if any Observable errors, combineLatest will also immediately error.

It is possible to change default update/complete strategy behaviour with an optional strategy object.

diff --git a/dev/observables/types/combined_updates/index.html b/dev/observables/types/combined_updates/index.html index 3b586682b..84763fa7f 100644 --- a/dev/observables/types/combined_updates/index.html +++ b/dev/observables/types/combined_updates/index.html @@ -1,3 +1,3 @@ Combined Updates · Rocket.jl

CombinedUpdates Observable

Rocket.combineLatestUpdatesFunction
combineLatestUpdates(sources...; strategy = PushEach())
-combineLatestUpdates(sources::S, strategy::G = PushEach()) where { S <: Tuple, U }

combineLatestUpdates is a more effiecient version of combineLatest(sources) + map_to(sources) operators chain.

Arguments

  • sources: input sources
  • strategy: optional update strategy for batching new values together

Note: combineLatestUpdates() completes immediately if sources are empty.

See also: Subscribable, subscribe!, PushEach, PushEachBut, PushNew, PushNewBut, PushStrategy

source
+combineLatestUpdates(sources::S, strategy::G = PushEach()) where { S <: Tuple, U }

combineLatestUpdates is a more effiecient version of combineLatest(sources) + map_to(sources) operators chain.

Arguments

Note: combineLatestUpdates() completes immediately if sources are empty.

See also: Subscribable, subscribe!, PushEach, PushEachBut, PushNew, PushNewBut, PushStrategy

source diff --git a/dev/observables/types/completed/index.html b/dev/observables/types/completed/index.html index 662989215..6f111cf7e 100644 --- a/dev/observables/types/completed/index.html +++ b/dev/observables/types/completed/index.html @@ -8,4 +8,4 @@ # output [LogActor] Completed -

See also: CompletedObservable, subscribe!, logger

source
Rocket.CompletedObservableType
CompletedObservable{D, H}(scheduler::H)

Observable that emits no items to the Actor and just sends a complete notification on subscription.

Constructor arguments

  • scheduler: Scheduler-like object

See also: Subscribable, completed

source
+

See also: CompletedObservable, subscribe!, logger

source
Rocket.CompletedObservableType
CompletedObservable{D, H}(scheduler::H)

Observable that emits no items to the Actor and just sends a complete notification on subscription.

Constructor arguments

  • scheduler: Scheduler-like object

See also: Subscribable, completed

source
diff --git a/dev/observables/types/concat/index.html b/dev/observables/types/concat/index.html index 5f4907a1b..f72e5b4c7 100644 --- a/dev/observables/types/concat/index.html +++ b/dev/observables/types/concat/index.html @@ -22,4 +22,4 @@ # output [LogActor] Data: 1 [LogActor] Data: 2 -[LogActor] Completed

See also: Subscribable, subscribe!

source +[LogActor] Completed

See also: Subscribable, subscribe!

source diff --git a/dev/observables/types/connectable/index.html b/dev/observables/types/connectable/index.html index 690d7cc03..94e4a23ee 100644 --- a/dev/observables/types/connectable/index.html +++ b/dev/observables/types/connectable/index.html @@ -14,4 +14,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 [LogActor] Completed -

See also: ConnectableObservable, connect, subscribe!

source
Rocket.connectFunction
connect(connectable::ConnectableObservable)

When connect is called, the subject passed to the multicast operator is subscribed to the source and the subject’s observers receive the multicast notifications, which fits our basic mental model of stream multicasting. Returns a subscription.

See also: connectable, ConnectableObservable

source
Rocket.ConnectableObservableType
ConnectableObservable{D}(subject, source)

A connectable observable encapsulates the multicasting infrastructure with provided subject, but does not immediately subscribe to the source. It subscribes to the source when its connect method is called.

See also: connect, Subscribable

source
+

See also: ConnectableObservable, connect, subscribe!

source
Rocket.connectFunction
connect(connectable::ConnectableObservable)

When connect is called, the subject passed to the multicast operator is subscribed to the source and the subject’s observers receive the multicast notifications, which fits our basic mental model of stream multicasting. Returns a subscription.

See also: connectable, ConnectableObservable

source
Rocket.ConnectableObservableType
ConnectableObservable{D}(subject, source)

A connectable observable encapsulates the multicasting infrastructure with provided subject, but does not immediately subscribe to the source. It subscribes to the source when its connect method is called.

See also: connect, Subscribable

source
diff --git a/dev/observables/types/defer/index.html b/dev/observables/types/defer/index.html index 5fc351b43..4ecd82414 100644 --- a/dev/observables/types/defer/index.html +++ b/dev/observables/types/defer/index.html @@ -10,4 +10,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -[LogActor] Completed

See also: Subscribable, subscribe!, logger

source

Description

defer allows you to create the Observable only when the Actor subscribes, and create a fresh Observable for each Actor. It waits until an Actor subscribes to it, and then it generates an Observable, typically with an Observable factory function. It does this afresh for each subscriber, so although each subscriber may think it is subscribing to the same Observable, in fact each subscriber gets its own individual Observable.

+[LogActor] Completed

See also: Subscribable, subscribe!, logger

source

Description

defer allows you to create the Observable only when the Actor subscribes, and create a fresh Observable for each Actor. It waits until an Actor subscribes to it, and then it generates an Observable, typically with an Observable factory function. It does this afresh for each subscriber, so although each subscriber may think it is subscribing to the same Observable, in fact each subscriber gets its own individual Observable.

diff --git a/dev/observables/types/faulted/index.html b/dev/observables/types/faulted/index.html index 7d58e5e64..4b59a6a59 100644 --- a/dev/observables/types/faulted/index.html +++ b/dev/observables/types/faulted/index.html @@ -9,4 +9,4 @@ # output [LogActor] Error: Error! -

See also: FaultedObservable, subscribe!

source
Rocket.FaultedObservableType
FaultedObservable{D, H}(err, scheduler::H)

Observable that emits no items to the Actor and just sends an error notification on subscription.

Constructor arguments

  • err: error to emit on subscription
  • scheduler: scheduler-like object

See also: faulted

source
+

See also: FaultedObservable, subscribe!

source
Rocket.FaultedObservableType
FaultedObservable{D, H}(err, scheduler::H)

Observable that emits no items to the Actor and just sends an error notification on subscription.

Constructor arguments

  • err: error to emit on subscription
  • scheduler: scheduler-like object

See also: faulted

source
diff --git a/dev/observables/types/file/index.html b/dev/observables/types/file/index.html index 200056fef..2b70c9d5a 100644 --- a/dev/observables/types/file/index.html +++ b/dev/observables/types/file/index.html @@ -1,2 +1,2 @@ -File · Rocket.jl
+File · Rocket.jl
diff --git a/dev/observables/types/function/index.html b/dev/observables/types/function/index.html index 0e65b14f7..3639c2f4d 100644 --- a/dev/observables/types/function/index.html +++ b/dev/observables/types/function/index.html @@ -39,4 +39,4 @@ # Arguments - `f::F`: function to be invoked on subscription -See also: [`Subscribable`](@ref), [`make`](@ref)source +See also: [`Subscribable`](@ref), [`make`](@ref)source diff --git a/dev/observables/types/generate/index.html b/dev/observables/types/generate/index.html index 1e2ed1e48..7a8deead1 100644 --- a/dev/observables/types/generate/index.html +++ b/dev/observables/types/generate/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: 1 [LogActor] Data: 2 -[LogActor] Completed

See also: ScheduledSubscribable, subscribe!

source +[LogActor] Completed

See also: ScheduledSubscribable, subscribe!

source diff --git a/dev/observables/types/interval/index.html b/dev/observables/types/interval/index.html index 596df85a1..39a9339b5 100644 --- a/dev/observables/types/interval/index.html +++ b/dev/observables/types/interval/index.html @@ -22,4 +22,4 @@ [LogActor] Data: 3 [LogActor] Data: 8 [LogActor] Data: 9 -[LogActor] Data: 10

See also: timer, TimerObservable, Subscribable

source +[LogActor] Data: 10

See also: timer, TimerObservable, Subscribable

source diff --git a/dev/observables/types/iterable/index.html b/dev/observables/types/iterable/index.html index 2db474dec..2ad20d86c 100644 --- a/dev/observables/types/iterable/index.html +++ b/dev/observables/types/iterable/index.html @@ -23,4 +23,4 @@ [LogActor] Data: l [LogActor] Data: l [LogActor] Data: o -[LogActor] Completed

See also: ScheduledSubscribable, subscribe!, from

source +[LogActor] Completed

See also: ScheduledSubscribable, subscribe!, from

source diff --git a/dev/observables/types/labeled/index.html b/dev/observables/types/labeled/index.html index 28a89a7e1..86d538b38 100644 --- a/dev/observables/types/labeled/index.html +++ b/dev/observables/types/labeled/index.html @@ -10,4 +10,4 @@ [LogActor] Data: (x = 1, y = 2) [LogActor] Data: (x = 2, y = 3) [LogActor] Data: (x = 3, y = 4) -[LogActor] Completed

See also: ScheduledSubscribable, subscribe!, from

source
Rocket.LabeledObservableType
LabeledObservable{D, S}()

An Observable that emits NamesTuple items from a source Observable that emits Tuple items.

See also: Subscribable, labeled

source
+[LogActor] Completed

See also: ScheduledSubscribable, subscribe!, from

source
Rocket.LabeledObservableType
LabeledObservable{D, S}()

An Observable that emits NamesTuple items from a source Observable that emits Tuple items.

See also: Subscribable, labeled

source
diff --git a/dev/observables/types/merged/index.html b/dev/observables/types/merged/index.html index 868d6cc07..3fbf55972 100644 --- a/dev/observables/types/merged/index.html +++ b/dev/observables/types/merged/index.html @@ -43,4 +43,4 @@ [LogActor] Data: l [LogActor] Data: o [LogActor] Data: 1 -[LogActor] Completed

See also: Subscribable

source +[LogActor] Completed

See also: Subscribable

source diff --git a/dev/observables/types/network/index.html b/dev/observables/types/network/index.html index 7e66a9a8f..6aae2931e 100644 --- a/dev/observables/types/network/index.html +++ b/dev/observables/types/network/index.html @@ -3,4 +3,4 @@ network(::Type{D}, address::A, port::Int) where { D, A <: IPAddr } network(::Type{Vector{D}}, port::Int, buffer_size::Int) where D -network(::Type{Vector{D}}, address::A, port::Int, buffer_size::Int) where { D, A <: IPAddr }

Creation operator for the NetworkObservable that emits messages from the server with specified address and port arguments.

See also: NetworkObservable, subscribe!

source
Rocket.NetworkObservableType
NetworkObservable{D, Address, Port, S}()

NetworkObservable listens for the messages of type D from remote server with specified Address and Port parameters.

See also: network, Subscribable

source
+network(::Type{Vector{D}}, address::A, port::Int, buffer_size::Int) where { D, A <: IPAddr }

Creation operator for the NetworkObservable that emits messages from the server with specified address and port arguments.

See also: NetworkObservable, subscribe!

source
Rocket.NetworkObservableType
NetworkObservable{D, Address, Port, S}()

NetworkObservable listens for the messages of type D from remote server with specified Address and Port parameters.

See also: network, Subscribable

source
diff --git a/dev/observables/types/never/index.html b/dev/observables/types/never/index.html index b66541b77..584553c4a 100644 --- a/dev/observables/types/never/index.html +++ b/dev/observables/types/never/index.html @@ -6,4 +6,4 @@ ; # output -

See also: NeverObservable, subscribe!, logger

source
Rocket.NeverObservableType
NeverObservable{D}()

An Observable that emits no items to the Observer and never completes.

Type parameters

  • D: Type of Observable data

See also: Subscribable, never

source
+

See also: NeverObservable, subscribe!, logger

source
Rocket.NeverObservableType
NeverObservable{D}()

An Observable that emits no items to the Observer and never completes.

Type parameters

  • D: Type of Observable data

See also: Subscribable, never

source
diff --git a/dev/observables/types/proxy/index.html b/dev/observables/types/proxy/index.html index 7aa17d188..eb6d8a5a6 100644 --- a/dev/observables/types/proxy/index.html +++ b/dev/observables/types/proxy/index.html @@ -27,4 +27,4 @@ [LogActor] Data: 9 [LogActor] Data: 16 [LogActor] Data: 25 -[LogActor] Completed

See also: ProxyObservable, ActorProxy, SourceProxy, ActorSourceProxy

source
Rocket.ProxyObservableType
ProxyObservable{L, S, P}(proxied_source::S, proxy::P)

An interface for proxied Observables.

See also: proxy

source
Rocket.ActorProxyType
ActorProxy

Can be used as a super type for common proxy object. Automatically specifies ValidActorProxy trait behavior. Each ActorProxy must implement its own method for actor_proxy!(::Type, proxy, actor) function which have to return a valid actor object.

See also: proxy, actor_proxy!

source
Rocket.SourceProxyType
SourceProxy

Can be used as a super type for common proxy object. Automatically specifies ValidSourceProxy trait behavior. Each SourceProxy must implement its own method for source_proxy!(::Type, proxy, source) function which have to return a valid subscribable object.

See also: proxy, source_proxy!

source
Rocket.ActorSourceProxyType
ActorSourceProxy

Can be used as a super type for common proxy object. Automatically specifies ValidActorSourceProxy trait behavior. Each ActorSourceProxy must implement its own method for source_proxy!(::Type, proxy, source) function which have to return a valid subscribable object and also for actor_proxy!(::Type, proxy, actor) function which have to return a valid actor object..

See also: proxy, actor_proxy!, source_proxy!

source
Rocket.actor_proxy!Function
actor_proxy!(::Type, proxy, actor)

This is function is used to wrap an actor with its proxied version given a particular proxy object. Must return another actor. Each valid ActorProxy and ActorSourceProxy must implement its own method for actor_proxy! function. The first argument is the same as the type of data of the connected proxy observable.

See also: proxy, ActorProxy, ActorSourceProxy

source
Rocket.source_proxy!Function
source_proxy!(::Type, proxy, source)

This is function is used to wrap a source with its proxied version given a particular proxy object. Must return another Observable. Each valid SourceProxy and ActorSourceProxy must implement its own method for source_proxy! function. The first argument is the same as the type of data of the connected proxy observable.

See also: proxy, SourceProxy, ActorSourceProxy

source
+[LogActor] Completed

See also: ProxyObservable, ActorProxy, SourceProxy, ActorSourceProxy

source
Rocket.ProxyObservableType
ProxyObservable{L, S, P}(proxied_source::S, proxy::P)

An interface for proxied Observables.

See also: proxy

source
Rocket.ActorProxyType
ActorProxy

Can be used as a super type for common proxy object. Automatically specifies ValidActorProxy trait behavior. Each ActorProxy must implement its own method for actor_proxy!(::Type, proxy, actor) function which have to return a valid actor object.

See also: proxy, actor_proxy!

source
Rocket.SourceProxyType
SourceProxy

Can be used as a super type for common proxy object. Automatically specifies ValidSourceProxy trait behavior. Each SourceProxy must implement its own method for source_proxy!(::Type, proxy, source) function which have to return a valid subscribable object.

See also: proxy, source_proxy!

source
Rocket.ActorSourceProxyType
ActorSourceProxy

Can be used as a super type for common proxy object. Automatically specifies ValidActorSourceProxy trait behavior. Each ActorSourceProxy must implement its own method for source_proxy!(::Type, proxy, source) function which have to return a valid subscribable object and also for actor_proxy!(::Type, proxy, actor) function which have to return a valid actor object..

See also: proxy, actor_proxy!, source_proxy!

source
Rocket.actor_proxy!Function
actor_proxy!(::Type, proxy, actor)

This is function is used to wrap an actor with its proxied version given a particular proxy object. Must return another actor. Each valid ActorProxy and ActorSourceProxy must implement its own method for actor_proxy! function. The first argument is the same as the type of data of the connected proxy observable.

See also: proxy, ActorProxy, ActorSourceProxy

source
Rocket.source_proxy!Function
source_proxy!(::Type, proxy, source)

This is function is used to wrap a source with its proxied version given a particular proxy object. Must return another Observable. Each valid SourceProxy and ActorSourceProxy must implement its own method for source_proxy! function. The first argument is the same as the type of data of the connected proxy observable.

See also: proxy, SourceProxy, ActorSourceProxy

source
diff --git a/dev/observables/types/race/index.html b/dev/observables/types/race/index.html index 491eaaaf8..502396e70 100644 --- a/dev/observables/types/race/index.html +++ b/dev/observables/types/race/index.html @@ -20,4 +20,4 @@ # output [LogActor] Data: 2 -[LogActor] Completed

See also: Subscribable, subscribe!

source +[LogActor] Completed

See also: Subscribable, subscribe!

source diff --git a/dev/observables/types/single/index.html b/dev/observables/types/single/index.html index d2d459916..805a479af 100644 --- a/dev/observables/types/single/index.html +++ b/dev/observables/types/single/index.html @@ -9,4 +9,4 @@ [LogActor] Data: 1 [LogActor] Completed -

See also: SingleObservable, subscribe!, logger

source
Rocket.SingleObservableType
SingleObservable{D, H}(value::D, scheduler::H)

SingleObservable wraps single value of type D into a observable.

Constructor arguments

  • value: a single value to emit
  • scheduler: scheduler-like object

See also: of, Subscribable

source
+

See also: SingleObservable, subscribe!, logger

source
Rocket.SingleObservableType
SingleObservable{D, H}(value::D, scheduler::H)

SingleObservable wraps single value of type D into a observable.

Constructor arguments

  • value: a single value to emit
  • scheduler: scheduler-like object

See also: of, Subscribable

source
diff --git a/dev/observables/types/timer/index.html b/dev/observables/types/timer/index.html index 37c33803d..e99bd2bc1 100644 --- a/dev/observables/types/timer/index.html +++ b/dev/observables/types/timer/index.html @@ -16,4 +16,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 -

See also: interval, TimerObservable, subscribe!, logger

source
Rocket.TimerObservableType
TimerObservable

An Observable that starts emitting after an delay and emits ever increasing numbers after each period of time thereafter.

Parameters

  • delay: The initial delay time specified as an integer denoting milliseconds to wait before emitting the first value of 0`.
  • period: The minimum period of time in milliseconds between emissions of the subsequent numbers.

See also: timer, Subscribable

source
+

See also: interval, TimerObservable, subscribe!, logger

source
Rocket.TimerObservableType
TimerObservable

An Observable that starts emitting after an delay and emits ever increasing numbers after each period of time thereafter.

Parameters

  • delay: The initial delay time specified as an integer denoting milliseconds to wait before emitting the first value of 0`.
  • period: The minimum period of time in milliseconds between emissions of the subsequent numbers.

See also: timer, Subscribable

source
diff --git a/dev/observables/types/zipped/index.html b/dev/observables/types/zipped/index.html index 9c1a61827..7f322d622 100644 --- a/dev/observables/types/zipped/index.html +++ b/dev/observables/types/zipped/index.html @@ -30,4 +30,4 @@ # output -[LogActor] Completed

See also: Subscribable, subscribe!

source +[LogActor] Completed

See also: Subscribable, subscribe!

source diff --git a/dev/operators/about/index.html b/dev/operators/about/index.html index 2311eb389..ba5de2b6e 100644 --- a/dev/operators/about/index.html +++ b/dev/operators/about/index.html @@ -55,4 +55,4 @@ // Logs // [LogActor] Data: 20 -// [LogActor] Completed

For stylistic reasons, on_call!(operator, source) is never used in practice - even if there is only one operator. Instead, source |> operator() is generally preferred.

+// [LogActor] Completed

For stylistic reasons, on_call!(operator, source) is never used in practice - even if there is only one operator. Instead, source |> operator() is generally preferred.

diff --git a/dev/operators/all/index.html b/dev/operators/all/index.html index 40aae8b86..1f8cfe45a 100644 --- a/dev/operators/all/index.html +++ b/dev/operators/all/index.html @@ -1,2 +1,2 @@ -All · Rocket.jl

List of all available operators

There are operators for different purposes, and they may be categorized as: creation, transformation, filtering, joining, multicasting, error handling, utility, etc.

Creation operators

Transformation operators

Filtering operators

Mathematical and Aggregate operators

Error handling operators

Join operator

Multicasting operators

Utility operators

+All · Rocket.jl

List of all available operators

There are operators for different purposes, and they may be categorized as: creation, transformation, filtering, joining, multicasting, error handling, utility, etc.

Creation operators

Transformation operators

Filtering operators

Mathematical and Aggregate operators

Error handling operators

Join operator

Multicasting operators

Utility operators

diff --git a/dev/operators/creation/about/index.html b/dev/operators/creation/about/index.html index ffcdc3195..534a206c3 100644 --- a/dev/operators/creation/about/index.html +++ b/dev/operators/creation/about/index.html @@ -1,2 +1,2 @@ -Creation · Rocket.jl
+Creation · Rocket.jl
diff --git a/dev/operators/errors/about/index.html b/dev/operators/errors/about/index.html index 9f3edabae..cb7971375 100644 --- a/dev/operators/errors/about/index.html +++ b/dev/operators/errors/about/index.html @@ -1,2 +1,2 @@ -About error handling operators · Rocket.jl
+About error handling operators · Rocket.jl
diff --git a/dev/operators/errors/catch_error/index.html b/dev/operators/errors/catch_error/index.html index 6c5028597..5c965121b 100644 --- a/dev/operators/errors/catch_error/index.html +++ b/dev/operators/errors/catch_error/index.html @@ -11,4 +11,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 [LogActor] Data: 1 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, rerun, logger, safe

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, rerun, logger, safe

source

See also

Operators

diff --git a/dev/operators/errors/error_if/index.html b/dev/operators/errors/error_if/index.html index 3c55c576f..3f4e7a6a9 100644 --- a/dev/operators/errors/error_if/index.html +++ b/dev/operators/errors/error_if/index.html @@ -13,4 +13,4 @@ # output Next: 1 Next: 2 -Error: CustomError

See also: error_if_not, error_if_empty, default_if_empty, lambda

source

See also

Operators

+Error: CustomError

See also: error_if_not, error_if_empty, default_if_empty, lambda

source

See also

Operators

diff --git a/dev/operators/errors/error_if_not/index.html b/dev/operators/errors/error_if_not/index.html index 08257f4cd..dca01fe55 100644 --- a/dev/operators/errors/error_if_not/index.html +++ b/dev/operators/errors/error_if_not/index.html @@ -12,4 +12,4 @@ # output Next: 1 -Error: CustomError

See also: error_if, error_if_empty, default_if_empty, logger

source

See also

Operators

+Error: CustomError

See also: error_if, error_if_empty, default_if_empty, logger

source

See also

Operators

diff --git a/dev/operators/errors/rerun/index.html b/dev/operators/errors/rerun/index.html index f6804f1d3..dfe839529 100644 --- a/dev/operators/errors/rerun/index.html +++ b/dev/operators/errors/rerun/index.html @@ -11,4 +11,4 @@ [LogActor] Data: 1 [LogActor] Data: 1 [LogActor] Data: 1 -[LogActor] Error: ErrorException("Error")

See also: AbstractOperator, InferableOperator, catch_error, logger, safe

source

Description

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

See also

Operators

+[LogActor] Error: ErrorException("Error")

See also: AbstractOperator, InferableOperator, catch_error, logger, safe

source

Description

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

See also

Operators

diff --git a/dev/operators/filtering/about/index.html b/dev/operators/filtering/about/index.html index 29d138174..c6c80f172 100644 --- a/dev/operators/filtering/about/index.html +++ b/dev/operators/filtering/about/index.html @@ -1,2 +1,2 @@ -About filtering operators · Rocket.jl
+About filtering operators · Rocket.jl
diff --git a/dev/operators/filtering/filter/index.html b/dev/operators/filtering/filter/index.html index 0d50ac014..41d2edef6 100644 --- a/dev/operators/filtering/filter/index.html +++ b/dev/operators/filtering/filter/index.html @@ -10,4 +10,4 @@ [LogActor] Data: 2 [LogActor] Data: 4 [LogActor] Data: 6 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

Like filter(f, array), this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

Like filter(f, array), this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

See also

Operators

diff --git a/dev/operators/filtering/filter_type/index.html b/dev/operators/filtering/filter_type/index.html index f9d9e9315..fa1174dbf 100644 --- a/dev/operators/filtering/filter_type/index.html +++ b/dev/operators/filtering/filter_type/index.html @@ -10,4 +10,4 @@ [LogActor] Data: 1 [LogActor] Data: 3 [LogActor] Data: 5 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/filtering/find/index.html b/dev/operators/filtering/find/index.html index 3c15e4653..dfb0e216b 100644 --- a/dev/operators/filtering/find/index.html +++ b/dev/operators/filtering/find/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: 2 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Does not emit an error if a valid value is not found.

See also

Operators, take

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Does not emit an error if a valid value is not found.

See also

Operators, take

diff --git a/dev/operators/filtering/find_index/index.html b/dev/operators/filtering/find_index/index.html index a9b3cfb0c..df70a04ae 100644 --- a/dev/operators/filtering/find_index/index.html +++ b/dev/operators/filtering/find_index/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: 3 -[LogActor] Completed

See also: find, AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

It's like find, but emits the index of the found value, not the value itself.

See also

Operators, take

+[LogActor] Completed

See also: find, AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

It's like find, but emits the index of the found value, not the value itself.

See also

Operators, take

diff --git a/dev/operators/filtering/first/index.html b/dev/operators/filtering/first/index.html index 725bb7a5d..071ca8cda 100644 --- a/dev/operators/filtering/first/index.html +++ b/dev/operators/filtering/first/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: 1 -[LogActor] Completed

See also: take, logger

source

Description

An alias for take(1) operator.

See also

Operators, take

+[LogActor] Completed

See also: take, logger

source

Description

An alias for take(1) operator.

See also

Operators, take

diff --git a/dev/operators/filtering/ignore/index.html b/dev/operators/filtering/ignore/index.html index d30890960..e7a32980b 100644 --- a/dev/operators/filtering/ignore/index.html +++ b/dev/operators/filtering/ignore/index.html @@ -11,4 +11,4 @@ [LogActor] Data: 3 [LogActor] Data: 4 [LogActor] Data: 5 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/filtering/last/index.html b/dev/operators/filtering/last/index.html index e4d13d505..c923a8b23 100644 --- a/dev/operators/filtering/last/index.html +++ b/dev/operators/filtering/last/index.html @@ -27,4 +27,4 @@ # output [LogActor] Data: 1 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

last operator returns an Observable that emits only the last item emitted by the source Observable.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

last operator returns an Observable that emits only the last item emitted by the source Observable.

See also

Operators

diff --git a/dev/operators/filtering/some/index.html b/dev/operators/filtering/some/index.html index a112a1fd9..6e535ef12 100644 --- a/dev/operators/filtering/some/index.html +++ b/dev/operators/filtering/some/index.html @@ -10,4 +10,4 @@ [LogActor] Data: 1 [LogActor] Data: 3 [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, max, min, logger

source

Description

This operator takes values from the source Observable and only emits those values that are not nothing.

See also

Operators, filter

+

See also: AbstractOperator, InferableOperator, ProxyObservable, max, min, logger

source

Description

This operator takes values from the source Observable and only emits those values that are not nothing.

See also

Operators, filter

diff --git a/dev/operators/filtering/take/index.html b/dev/operators/filtering/take/index.html index 895ba15fe..a87d45b69 100644 --- a/dev/operators/filtering/take/index.html +++ b/dev/operators/filtering/take/index.html @@ -13,4 +13,4 @@ [LogActor] Data: 3 [LogActor] Data: 4 [LogActor] Data: 5 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values, then all of its values are emitted. Afterwards, the Observable completes regardless of whether the source completed.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values, then all of its values are emitted. Afterwards, the Observable completes regardless of whether the source completed.

See also

Operators

diff --git a/dev/operators/filtering/take_until/index.html b/dev/operators/filtering/take_until/index.html index e13c010d9..0368162a0 100644 --- a/dev/operators/filtering/take_until/index.html +++ b/dev/operators/filtering/take_until/index.html @@ -29,4 +29,4 @@ [LogActor] Data: 0 [LogActor] Data: 1 [LogActor] Data: 2 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

take_until subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value, the output Observable stops mirroring the source Observable and completes. If the notifier doesn't emit any value and completes then take_until also completes.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

take_until subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value, the output Observable stops mirroring the source Observable and completes. If the notifier doesn't emit any value and completes then take_until also completes.

See also

Operators

diff --git a/dev/operators/join/about/index.html b/dev/operators/join/about/index.html index a827e4da0..7db613306 100644 --- a/dev/operators/join/about/index.html +++ b/dev/operators/join/about/index.html @@ -1,2 +1,2 @@ -Join category · Rocket.jl

Join category

There are operators for different purposes, and they may be categorized as: creation, transformation, filtering, joining, multicasting, error handling, utility, etc. In the following list you will find all the operators organized in join category.

See also

Operators

+Join category · Rocket.jl

Join category

There are operators for different purposes, and they may be categorized as: creation, transformation, filtering, joining, multicasting, error handling, utility, etc. In the following list you will find all the operators organized in join category.

See also

Operators

diff --git a/dev/operators/join/with_latest/index.html b/dev/operators/join/with_latest/index.html index be805fff6..aa28961e2 100644 --- a/dev/operators/join/with_latest/index.html +++ b/dev/operators/join/with_latest/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: (1, 5) -[LogActor] Completed

See also: AbstractOperator, InferableOperator

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator

source

See also

Operators

diff --git a/dev/operators/mathematical/about/index.html b/dev/operators/mathematical/about/index.html index 78d080ab9..0e1c3e8de 100644 --- a/dev/operators/mathematical/about/index.html +++ b/dev/operators/mathematical/about/index.html @@ -1,2 +1,2 @@ -About mathematical operators · Rocket.jl
+About mathematical operators · Rocket.jl
diff --git a/dev/operators/mathematical/count/index.html b/dev/operators/mathematical/count/index.html index 6154ba295..269d9ea3f 100644 --- a/dev/operators/mathematical/count/index.html +++ b/dev/operators/mathematical/count/index.html @@ -17,4 +17,4 @@ # output [LogActor] Data: 42 -[LogActor] Completed

See also

Operators

+[LogActor] Completed

See also

Operators

diff --git a/dev/operators/mathematical/max/index.html b/dev/operators/mathematical/max/index.html index a77dcd696..12328d6b3 100644 --- a/dev/operators/mathematical/max/index.html +++ b/dev/operators/mathematical/max/index.html @@ -9,4 +9,4 @@ [LogActor] Data: 42 [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

The max operator operates on an Observable of similar objects. When the source Observable completes, it emits the item with the largest value.

See also

Operators

+

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

The max operator operates on an Observable of similar objects. When the source Observable completes, it emits the item with the largest value.

See also

Operators

diff --git a/dev/operators/mathematical/min/index.html b/dev/operators/mathematical/min/index.html index a4b7f21cb..b5f3047e6 100644 --- a/dev/operators/mathematical/min/index.html +++ b/dev/operators/mathematical/min/index.html @@ -9,4 +9,4 @@ [LogActor] Data: 1 [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

The min operator operates on an Observable of similar objects. When source Observable completes, it emits the item with the smallest value.

See also

Operators

+

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

The min operator operates on an Observable of similar objects. When source Observable completes, it emits the item with the smallest value.

See also

Operators

diff --git a/dev/operators/mathematical/reduce/index.html b/dev/operators/mathematical/reduce/index.html index 6a843e6b9..7c73799c7 100644 --- a/dev/operators/mathematical/reduce/index.html +++ b/dev/operators/mathematical/reduce/index.html @@ -20,4 +20,4 @@ [LogActor] Data: 903 [LogActor] Completed -

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

reduce applies an accumulator function to each value of the source Observable (from the past) and reduces it to a single value that is emitted by the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying scan followed by last.

It returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value of the accumulator. If no seed value is specified, the first item of the source is used as the seed.

See also

Operators, scan, last

+

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

reduce applies an accumulator function to each value of the source Observable (from the past) and reduces it to a single value that is emitted by the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying scan followed by last.

It returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value of the accumulator. If no seed value is specified, the first item of the source is used as the seed.

See also

Operators, scan, last

diff --git a/dev/operators/mathematical/sum/index.html b/dev/operators/mathematical/sum/index.html index df620f420..c374be2c4 100644 --- a/dev/operators/mathematical/sum/index.html +++ b/dev/operators/mathematical/sum/index.html @@ -19,4 +19,4 @@ [LogActor] Data: 1000 [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, reduce, logger

source

Description

sum operates on an Observable of objects on which + is defined. When the source Observable completes, it emits the sum of all previous items. The sum operator is similar to reduce(T, T, +) (see reduce).

See also

Operators, reduce

+

See also: AbstractOperator, InferableOperator, ProxyObservable, reduce, logger

source

Description

sum operates on an Observable of objects on which + is defined. When the source Observable completes, it emits the sum of all previous items. The sum operator is similar to reduce(T, T, +) (see reduce).

See also

Operators, reduce

diff --git a/dev/operators/multicasting/about/index.html b/dev/operators/multicasting/about/index.html index 725a34171..c20764c03 100644 --- a/dev/operators/multicasting/about/index.html +++ b/dev/operators/multicasting/about/index.html @@ -1,2 +1,2 @@ -About multicasting operators · Rocket.jl
+About multicasting operators · Rocket.jl
diff --git a/dev/operators/multicasting/multicast/index.html b/dev/operators/multicasting/multicast/index.html index 3035b76fb..938a85317 100644 --- a/dev/operators/multicasting/multicast/index.html +++ b/dev/operators/multicasting/multicast/index.html @@ -30,4 +30,4 @@ [1] Data: 5 [2] Data: 5 [1] Completed -[2] Completed

See also: ConnectableObservable, Subject, share, publish

source

See also

Operators

+[2] Completed

See also: ConnectableObservable, Subject, share, publish

source

See also

Operators

diff --git a/dev/operators/multicasting/publish/index.html b/dev/operators/multicasting/publish/index.html index 10b52f5cb..aa6970ce6 100644 --- a/dev/operators/multicasting/publish/index.html +++ b/dev/operators/multicasting/publish/index.html @@ -1,2 +1,2 @@ -publish · Rocket.jl

Publish Operators

See also

Operators

+publish · Rocket.jl

Publish Operators

See also

Operators

diff --git a/dev/operators/multicasting/share/index.html b/dev/operators/multicasting/share/index.html index a4416c288..7f17db2c6 100644 --- a/dev/operators/multicasting/share/index.html +++ b/dev/operators/multicasting/share/index.html @@ -1,2 +1,2 @@ -share · Rocket.jl

Share Operators

See also

Operators

+share · Rocket.jl

Share Operators

See also

Operators

diff --git a/dev/operators/transformation/about/index.html b/dev/operators/transformation/about/index.html index 21ef59bc2..2547cb9a8 100644 --- a/dev/operators/transformation/about/index.html +++ b/dev/operators/transformation/about/index.html @@ -1,2 +1,2 @@ -About transformation operators · Rocket.jl
+About transformation operators · Rocket.jl
diff --git a/dev/operators/transformation/accumulated/index.html b/dev/operators/transformation/accumulated/index.html index 06dcd2c20..0c85ee4e6 100644 --- a/dev/operators/transformation/accumulated/index.html +++ b/dev/operators/transformation/accumulated/index.html @@ -20,4 +20,4 @@ # output [LogActor] Data: [1] -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

Combines all values emitted by the source, using an accumulator function that joins a new source value with the all past values emmited into one single array. This is similar to scan with vcat accumulation function.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

Description

Combines all values emitted by the source, using an accumulator function that joins a new source value with the all past values emmited into one single array. This is similar to scan with vcat accumulation function.

See also

Operators

diff --git a/dev/operators/transformation/concat_map/index.html b/dev/operators/transformation/concat_map/index.html index d9eb21cc8..70fd964d3 100644 --- a/dev/operators/transformation/concat_map/index.html +++ b/dev/operators/transformation/concat_map/index.html @@ -13,4 +13,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning

If source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note

concat_map is equivalent to merge_map with concurrency parameter set to 1.

See also

Operators, merge_map

+[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning

If source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note

concat_map is equivalent to merge_map with concurrency parameter set to 1.

See also

Operators, merge_map

diff --git a/dev/operators/transformation/concat_map_to/index.html b/dev/operators/transformation/concat_map_to/index.html index 7a394d77c..82e00bc64 100644 --- a/dev/operators/transformation/concat_map_to/index.html +++ b/dev/operators/transformation/concat_map_to/index.html @@ -16,4 +16,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -[LogActor] Completed

See also: concat_map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source
Note

concat_map_to is equivalent to concat_map with mappingFn set to (_) -> inner_observable.

See also

Operators, concat_map

+[LogActor] Completed

See also: concat_map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source
Note

concat_map_to is equivalent to concat_map with mappingFn set to (_) -> inner_observable.

See also

Operators, concat_map

diff --git a/dev/operators/transformation/enumerate/index.html b/dev/operators/transformation/enumerate/index.html index f4a3f2fce..ddc19065b 100644 --- a/dev/operators/transformation/enumerate/index.html +++ b/dev/operators/transformation/enumerate/index.html @@ -24,4 +24,4 @@ [LogActor] Data: (0.6, 4) [LogActor] Data: (0.8, 5) [LogActor] Data: (1.0, 6) -[LogActor] Completed

See also

Operators, scan

+[LogActor] Completed

See also

Operators, scan

diff --git a/dev/operators/transformation/exhaust_map/index.html b/dev/operators/transformation/exhaust_map/index.html index c4cebc8af..dba877b6e 100644 --- a/dev/operators/transformation/exhaust_map/index.html +++ b/dev/operators/transformation/exhaust_map/index.html @@ -9,4 +9,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 -[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/transformation/lowercase/index.html b/dev/operators/transformation/lowercase/index.html index 5b03006a2..2da4dbb74 100644 --- a/dev/operators/transformation/lowercase/index.html +++ b/dev/operators/transformation/lowercase/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: hello, world! -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, uppercase

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, uppercase

diff --git a/dev/operators/transformation/map/index.html b/dev/operators/transformation/map/index.html index 573091f19..85992eea9 100644 --- a/dev/operators/transformation/map/index.html +++ b/dev/operators/transformation/map/index.html @@ -10,4 +10,4 @@ [LogActor] Data: 1 [LogActor] Data: 4 [LogActor] Data: 9 -[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Like map(f, array), the map operator applies a function to each source value.

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Like map(f, array), the map operator applies a function to each source value.

See also

Operators

diff --git a/dev/operators/transformation/map_to/index.html b/dev/operators/transformation/map_to/index.html index 62cd5c3b7..6a3c2350c 100644 --- a/dev/operators/transformation/map_to/index.html +++ b/dev/operators/transformation/map_to/index.html @@ -10,4 +10,4 @@ [LogActor] Data: a [LogActor] Data: a [LogActor] Data: a -[LogActor] Completed

See also: map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

See also

Operators

+[LogActor] Completed

See also: map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

Description

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

See also

Operators

diff --git a/dev/operators/transformation/merge_map/index.html b/dev/operators/transformation/merge_map/index.html index ee5d3bdce..f15ecda61 100644 --- a/dev/operators/transformation/merge_map/index.html +++ b/dev/operators/transformation/merge_map/index.html @@ -13,4 +13,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 [LogActor] Data: 3 -[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/transformation/override/index.html b/dev/operators/transformation/override/index.html index 245ea999c..e1d18d443 100644 --- a/dev/operators/transformation/override/index.html +++ b/dev/operators/transformation/override/index.html @@ -30,4 +30,4 @@ [LogActor] Data: 4 [LogActor] Data: -2 [LogActor] Data: -2

See also: OverrideHandler

source
Rocket.OverrideHandlerType
OverrideHandler(::Type{T}, value::Union{Nothing, T}) where T
-OverrideHandler(::Type{T}) where T

Handler used in substitute operator.

See also: substitute

source

See also

Operators

+OverrideHandler(::Type{T}) where T

Handler used in substitute operator.

See also: substitute

source

See also

Operators

diff --git a/dev/operators/transformation/pairwise/index.html b/dev/operators/transformation/pairwise/index.html index b7486878a..dc039173d 100644 --- a/dev/operators/transformation/pairwise/index.html +++ b/dev/operators/transformation/pairwise/index.html @@ -26,4 +26,4 @@ [LogActor] Data: (2, 3) [LogActor] Data: (3, 4) [LogActor] Data: (4, 5) -[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger

source

See also

Operators

diff --git a/dev/operators/transformation/scan/index.html b/dev/operators/transformation/scan/index.html index a852ac4b6..f1b2f55c5 100644 --- a/dev/operators/transformation/scan/index.html +++ b/dev/operators/transformation/scan/index.html @@ -24,4 +24,4 @@ [LogActor] Data: [1, 2] [LogActor] Data: [1, 2, 3] [LogActor] Completed -

See also: AbstractOperator, RightTypedOperator, ProxyObservable, reduce, logger

source

Description

Combines all values emitted by the source, using an accumulator function that joins a new source value with the past accumulation. This is similar to reduce, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

See also

Operators

+

See also: AbstractOperator, RightTypedOperator, ProxyObservable, reduce, logger

source

Description

Combines all values emitted by the source, using an accumulator function that joins a new source value with the past accumulation. This is similar to reduce, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

See also

Operators

diff --git a/dev/operators/transformation/start_with/index.html b/dev/operators/transformation/start_with/index.html index 0587e8185..16b7baace 100644 --- a/dev/operators/transformation/start_with/index.html +++ b/dev/operators/transformation/start_with/index.html @@ -11,4 +11,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/transformation/substitute/index.html b/dev/operators/transformation/substitute/index.html index 589ab1604..3c76bdf6b 100644 --- a/dev/operators/transformation/substitute/index.html +++ b/dev/operators/transformation/substitute/index.html @@ -28,4 +28,4 @@ [LogActor] Data: i = 1 [LogActor] Data: i = 3 [LogActor] Data: i = 3 -[LogActor] Data: i = 3

See also: SubstituteHandler

source
Rocket.SubstituteHandlerType
SubstituteHandler()

handler used to release! new values in substitute operator.

See also: substitute

source

See also

Operators

+[LogActor] Data: i = 3

See also: SubstituteHandler

source
Rocket.SubstituteHandlerType
SubstituteHandler()

handler used to release! new values in substitute operator.

See also: substitute

source

See also

Operators

diff --git a/dev/operators/transformation/switch_map/index.html b/dev/operators/transformation/switch_map/index.html index 88a76a69e..35dce84f4 100644 --- a/dev/operators/transformation/switch_map/index.html +++ b/dev/operators/transformation/switch_map/index.html @@ -21,4 +21,4 @@ [LogActor] Data: 1.0 [LogActor] Data: 4.0 [LogActor] Data: 9.0 -[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/transformation/switch_map_to/index.html b/dev/operators/transformation/switch_map_to/index.html index 646e1dac5..ce1e5c85f 100644 --- a/dev/operators/transformation/switch_map_to/index.html +++ b/dev/operators/transformation/switch_map_to/index.html @@ -16,4 +16,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -[LogActor] Completed

See also: switch_map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source
Note

switch_map_to is equivalent to switch_map with mappingFn set to (_) -> inner_observable.

See also

Operators

+[LogActor] Completed

See also: switch_map, AbstractOperator, RightTypedOperator, ProxyObservable, logger

source
Note

switch_map_to is equivalent to switch_map with mappingFn set to (_) -> inner_observable.

See also

Operators

diff --git a/dev/operators/transformation/to_array/index.html b/dev/operators/transformation/to_array/index.html index b75debb2d..ce12ea3e9 100644 --- a/dev/operators/transformation/to_array/index.html +++ b/dev/operators/transformation/to_array/index.html @@ -9,4 +9,4 @@ [LogActor] Data: [1, 2, 3] [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, lowercase

+

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, lowercase

diff --git a/dev/operators/transformation/uppercase/index.html b/dev/operators/transformation/uppercase/index.html index c896dcb0f..38fcaa0a7 100644 --- a/dev/operators/transformation/uppercase/index.html +++ b/dev/operators/transformation/uppercase/index.html @@ -8,4 +8,4 @@ # output [LogActor] Data: HELLO, WORLD! -[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, lowercase

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, ProxyObservable, logger

source

See also

Operators, map, lowercase

diff --git a/dev/operators/utility/about/index.html b/dev/operators/utility/about/index.html index 4b6eaa5d3..550a7dabb 100644 --- a/dev/operators/utility/about/index.html +++ b/dev/operators/utility/about/index.html @@ -1,2 +1,2 @@ -About utility operators · Rocket.jl
+About utility operators · Rocket.jl
diff --git a/dev/operators/utility/async/index.html b/dev/operators/utility/async/index.html index b952d5210..82d7e6cff 100644 --- a/dev/operators/utility/async/index.html +++ b/dev/operators/utility/async/index.html @@ -1,2 +1,2 @@ -async · Rocket.jl
+async · Rocket.jl
diff --git a/dev/operators/utility/default_if_empty/index.html b/dev/operators/utility/default_if_empty/index.html index d51d089e8..ec836ee7b 100644 --- a/dev/operators/utility/default_if_empty/index.html +++ b/dev/operators/utility/default_if_empty/index.html @@ -18,4 +18,4 @@ # output [LogActor] Data: 42 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger, map

source

Description

default_if_empty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger, map

source

Description

default_if_empty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

See also

Operators

diff --git a/dev/operators/utility/delay/index.html b/dev/operators/utility/delay/index.html index 2387830d9..38b0bb32c 100644 --- a/dev/operators/utility/delay/index.html +++ b/dev/operators/utility/delay/index.html @@ -14,4 +14,4 @@ 03:43: 1 03:43: 2 03:43: 3 -

See also

Operators

+

See also

Operators

diff --git a/dev/operators/utility/discontinue/index.html b/dev/operators/utility/discontinue/index.html index b5ecb831a..c23a55502 100644 --- a/dev/operators/utility/discontinue/index.html +++ b/dev/operators/utility/discontinue/index.html @@ -10,4 +10,4 @@ # output [LogActor] Data: 0 -[LogActor] Data: 1

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

+[LogActor] Data: 1

See also: AbstractOperator, RightTypedOperator, ProxyObservable, logger

source

See also

Operators

diff --git a/dev/operators/utility/error_if_empty/index.html b/dev/operators/utility/error_if_empty/index.html index 00dc66889..3f1b6d4c1 100644 --- a/dev/operators/utility/error_if_empty/index.html +++ b/dev/operators/utility/error_if_empty/index.html @@ -7,4 +7,4 @@ ; # output -[LogActor] Error: Empty

See also: AbstractOperator, InferableOperator, logger, map

source

Description

error_if_empty emits the values emitted by the source Observable or a specified error message if the source Observable is empty (completes without having emitted any next value).

See also

Operators

+[LogActor] Error: Empty

See also: AbstractOperator, InferableOperator, logger, map

source

Description

error_if_empty emits the values emitted by the source Observable or a specified error message if the source Observable is empty (completes without having emitted any next value).

See also

Operators

diff --git a/dev/operators/utility/limit_subscribers/index.html b/dev/operators/utility/limit_subscribers/index.html index de657a5a5..26cdb82c7 100644 --- a/dev/operators/utility/limit_subscribers/index.html +++ b/dev/operators/utility/limit_subscribers/index.html @@ -10,4 +10,4 @@ guard = LimitSubscribersGuard() # Cell 2 -subscription = subscribe!(some_stream |> limit_subscribers(guard), logger())

See also: LimitSubscribersGuard

source

See also

Operators

+subscription = subscribe!(some_stream |> limit_subscribers(guard), logger())

See also: LimitSubscribersGuard

source

See also

Operators

diff --git a/dev/operators/utility/noop/index.html b/dev/operators/utility/noop/index.html index 374054cc4..89fa7b794 100644 --- a/dev/operators/utility/noop/index.html +++ b/dev/operators/utility/noop/index.html @@ -22,4 +22,4 @@ [LogActor] Data: 1003 [LogActor] Data: 1004 [LogActor] Data: 1005 -[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger, map

source

See also

Operators

+[LogActor] Completed

See also: AbstractOperator, InferableOperator, logger, map

source

See also

Operators

diff --git a/dev/operators/utility/ref_count/index.html b/dev/operators/utility/ref_count/index.html index 2e776d894..5c2e05652 100644 --- a/dev/operators/utility/ref_count/index.html +++ b/dev/operators/utility/ref_count/index.html @@ -21,4 +21,4 @@ [1] Data: 4 [1] Data: 5 [1] Completed -[2] Completed

See also: AbstractOperator, publish, multicast, share

source

See also

Operators

+[2] Completed

See also: AbstractOperator, publish, multicast, share

source

See also

Operators

diff --git a/dev/operators/utility/safe/index.html b/dev/operators/utility/safe/index.html index 07fbf43ec..503c10bbf 100644 --- a/dev/operators/utility/safe/index.html +++ b/dev/operators/utility/safe/index.html @@ -1,2 +1,2 @@ -safe · Rocket.jl
+safe · Rocket.jl
diff --git a/dev/operators/utility/skip_complete/index.html b/dev/operators/utility/skip_complete/index.html index 43c4b9d15..2d2e889b0 100644 --- a/dev/operators/utility/skip_complete/index.html +++ b/dev/operators/utility/skip_complete/index.html @@ -9,4 +9,4 @@ [LogActor] Data: 1 [LogActor] Data: 2 [LogActor] Data: 3 -

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_next, logger

source

See also

Operators

+

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_next, logger

source

See also

Operators

diff --git a/dev/operators/utility/skip_error/index.html b/dev/operators/utility/skip_error/index.html index 86025944a..647f05e25 100644 --- a/dev/operators/utility/skip_error/index.html +++ b/dev/operators/utility/skip_error/index.html @@ -6,4 +6,4 @@ ; # output -

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_complete, logger

source

See also

Operators

+

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_complete, logger

source

See also

Operators

diff --git a/dev/operators/utility/skip_next/index.html b/dev/operators/utility/skip_next/index.html index 419e1f607..618c0a4a6 100644 --- a/dev/operators/utility/skip_next/index.html +++ b/dev/operators/utility/skip_next/index.html @@ -7,4 +7,4 @@ # output [LogActor] Completed -

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_complete, logger

source

See also

Operators

+

See also: AbstractOperator, InferableOperator, ProxyObservable, skip_error, skip_complete, logger

source

See also

Operators

diff --git a/dev/operators/utility/tap/index.html b/dev/operators/utility/tap/index.html index a76646b39..89a4dacdb 100644 --- a/dev/operators/utility/tap/index.html +++ b/dev/operators/utility/tap/index.html @@ -14,4 +14,4 @@ In tap: 3 [LogActor] Data: 3 [LogActor] Completed -

See also: tap_on_subscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect for every value emitted by the source.

This operator is useful for debugging your Observables, verifying correct values, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap is not subscribed, the side effects specified by the Observer will never happen. tap therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

+

See also: tap_on_subscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect for every value emitted by the source.

This operator is useful for debugging your Observables, verifying correct values, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap is not subscribed, the side effects specified by the Observer will never happen. tap therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

diff --git a/dev/operators/utility/tap_on_complete/index.html b/dev/operators/utility/tap_on_complete/index.html index b221497f5..2781321c2 100644 --- a/dev/operators/utility/tap_on_complete/index.html +++ b/dev/operators/utility/tap_on_complete/index.html @@ -12,4 +12,4 @@ [LogActor] Data: 3 [LogActor] Completed Complete event received -

See also: tap_on_subscribe, tap, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on complete event emission by the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap_on_complete is not subscribed, the side effects specified by the Observer will never happen. tap_on_complete therefore simply spies on future execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

+

See also: tap_on_subscribe, tap, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on complete event emission by the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap_on_complete is not subscribed, the side effects specified by the Observer will never happen. tap_on_complete therefore simply spies on future execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

diff --git a/dev/operators/utility/tap_on_subscribe/index.html b/dev/operators/utility/tap_on_subscribe/index.html index 2a13da2d1..ff60df1db 100644 --- a/dev/operators/utility/tap_on_subscribe/index.html +++ b/dev/operators/utility/tap_on_subscribe/index.html @@ -23,4 +23,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 [LogActor] Completed -Someone subscribed

See also: TapBeforeSubscription, TapAfterSubscription, tap, tap_on_unsubscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on subscription to the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap_on_subscribe is not subscribed, the side effects specified by the Observer will never happen. tap_on_subscribe therefore simply spies on future execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

+Someone subscribed

See also: TapBeforeSubscription, TapAfterSubscription, tap, tap_on_unsubscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on subscription to the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

Note: this operator differs from a subscribe on the Observable. If the Observable returned by tap_on_subscribe is not subscribed, the side effects specified by the Observer will never happen. tap_on_subscribe therefore simply spies on future execution, it does not trigger an execution to happen like subscribe does.

See also

Operators

diff --git a/dev/operators/utility/tap_on_unsubscribe/index.html b/dev/operators/utility/tap_on_unsubscribe/index.html index 3dc0776a4..4772a7ac5 100644 --- a/dev/operators/utility/tap_on_unsubscribe/index.html +++ b/dev/operators/utility/tap_on_unsubscribe/index.html @@ -12,4 +12,4 @@ [LogActor] Data: 2 [LogActor] Data: 3 [LogActor] Completed -Someone unsubscribed

See also: TapBeforeUnsubscription, TapAfterUnsubscription, tap, tap_on_subscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on unsubscription from the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

See also

Operators

+Someone unsubscribed

See also: TapBeforeUnsubscription, TapAfterUnsubscription, tap, tap_on_subscribe, tap_on_complete, logger

source

Description

Returns an Observable that resembles the source Observable, but modifies it so that the provided Observer is called to perform a side effect on unsubscription from the source.

This operator is useful for debugging your Observables, verifying correctness, or performing other side effects.

See also

Operators

diff --git a/dev/search/index.html b/dev/search/index.html index c2f1e928b..44fb0fb77 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · Rocket.jl

Loading search...

    +Search · Rocket.jl

    Loading search...

      diff --git a/dev/subjects/about/index.html b/dev/subjects/about/index.html index fbacea7a9..01562c456 100644 --- a/dev/subjects/about/index.html +++ b/dev/subjects/about/index.html @@ -83,4 +83,4 @@ # [Actor 1] Data: 2 # [Actor 1] Data: 3 # [Actor 2] Data: 3 - + diff --git a/dev/subjects/types/behavior/index.html b/dev/subjects/types/behavior/index.html index a3b1846bb..2b5df12f8 100644 --- a/dev/subjects/types/behavior/index.html +++ b/dev/subjects/types/behavior/index.html @@ -25,4 +25,4 @@ // [1] Data: 2 // [2] Data: 2 // [1] Data: 3 -// [2] Data: 3 +// [2] Data: 3 diff --git a/dev/subjects/types/pending/index.html b/dev/subjects/types/pending/index.html index bb0e7cbca..d03680e3b 100644 --- a/dev/subjects/types/pending/index.html +++ b/dev/subjects/types/pending/index.html @@ -24,4 +24,4 @@ [1] Completed [2] Completed [3] Data: 3 -[3] Completed +[3] Completed diff --git a/dev/subjects/types/recent/index.html b/dev/subjects/types/recent/index.html index 583581000..8b70cd950 100644 --- a/dev/subjects/types/recent/index.html +++ b/dev/subjects/types/recent/index.html @@ -23,4 +23,4 @@ // [1] Data: 2 // [2] Data: 2 // [1] Data: 3 -// [2] Data: 3 +// [2] Data: 3 diff --git a/dev/subjects/types/replay/index.html b/dev/subjects/types/replay/index.html index adff1b610..dd27d9443 100644 --- a/dev/subjects/types/replay/index.html +++ b/dev/subjects/types/replay/index.html @@ -29,4 +29,4 @@ // [2] Data: 3 // [2] Data: 4 // [1] Data: 5 -// [2] Data: 5 +// [2] Data: 5 diff --git a/dev/subjects/types/subject/index.html b/dev/subjects/types/subject/index.html index d80cf500a..8ea1bdcc7 100644 --- a/dev/subjects/types/subject/index.html +++ b/dev/subjects/types/subject/index.html @@ -19,4 +19,4 @@ // [1] Data: 1 // [1] Data: 2 // [1] Data: 3 -// [2] Data: 3 +// [2] Data: 3 diff --git a/dev/teardown/about/index.html b/dev/teardown/about/index.html index f703ef8ec..a63238898 100644 --- a/dev/teardown/about/index.html +++ b/dev/teardown/about/index.html @@ -21,4 +21,4 @@ # or similarly # unsubscribe!([ subscription1, subscription2 ]) -

      For more information about subscription and teardown logic see the API Section

      +

      For more information about subscription and teardown logic see the API Section

      diff --git a/dev/teardown/types/void/index.html b/dev/teardown/types/void/index.html index 34072a416..1809e0a3a 100644 --- a/dev/teardown/types/void/index.html +++ b/dev/teardown/types/void/index.html @@ -1,2 +1,2 @@ -Void · Rocket.jl
      +Void · Rocket.jl
      diff --git a/dev/todo/index.html b/dev/todo/index.html index 72aa4662e..5b51e24aa 100644 --- a/dev/todo/index.html +++ b/dev/todo/index.html @@ -1,2 +1,2 @@ -TODO · Rocket.jl

      TODO

      This package in under development and some features of the reactive framework not yet implemented.

      +TODO · Rocket.jl

      TODO

      This package in under development and some features of the reactive framework not yet implemented.

      diff --git a/dev/utils/index.html b/dev/utils/index.html index 30b67c3d9..4768eb027 100644 --- a/dev/utils/index.html +++ b/dev/utils/index.html @@ -17,4 +17,4 @@ v2 :: V2 ... vn :: VN -end

      See also: setstorage!

      source
      Rocket.setstorage!Function
      setstorage!(s, v, ::Val{I}) where I

      This function can be used to set a new value v for storage s with a given value v and index I. Using parametrized Val{I} for indexing ensures for index to be resolved at compile-time and if-else branch optimization.

      See also: @MStorage

      source
      +end

      See also: setstorage!

      source
      Rocket.setstorage!Function
      setstorage!(s, v, ::Val{I}) where I

      This function can be used to set a new value v for storage s with a given value v and index I. Using parametrized Val{I} for indexing ensures for index to be resolved at compile-time and if-else branch optimization.

      See also: @MStorage

      source