README.md

CallbagKit

Documentation

• Sources
• Sinkers
• Operators
• Pipes

---

Callbags has three major layers.

1. Producer Layer Sources:

This layer is responsible for sending data.

2. Operator Layer Operators:

This layer is responsible for receiving data and do some operation, then sending data. So this layer is considered as producer layer too. The only difference is that it cannot send data without receiving them first.

3. Consumer Layer Sinkers:

This layer is responsible for receiving data.

Visually represented as:

     required          optional         required
 ╭──────────────╮   ╭────────────╮   ╭────────────╮
 │              │<──│            │<──│            │
 │   Producer   │   │  Operator  │   │  Consumer  │
 │              │──>│            │──>│            │
 ╰──────────────╯   ╰────────────╯   ╰────────────╯

Note: each Callbags Layer has its own Architecture Design. However they share the following concept:

1. Subscribe Stage:

  ╭────────────────────────╮  
  │ ╭────────────────────╮ │  
<─┼─│    request Start   │<┼── Handshake (required)
  │ ╰────────────────────╯ │  
  │       Only once        │  
  │ ╭────────────────────╮ │  
──┼>│    receive Start   ├─┼─> HandshakeBack (required)
  │ ╰────────────────────╯ │  
  ╰────────────────────────╯  

2. Request/Receive Items Stage:

  ╭────────────────────────╮  
  │ ╭────────────────────╮ │  
<─┼─│    request Next    │<┼── WantItem (required for pullables)
  │ ╰────────────────────╯ │  
  │   As many as possible  │  
  │ ╭────────────────────╮ │  
──┼>│    receive Next    ├─┼─> TakeItem (optional)
  │ ╰────────────────────╯ │  
  ╰────────────────────────╯  

3. Unsubscribe Stage:

  ╭────────────────────────╮  
  │ ╭────────────────────╮ │  
<─┼─│ request Completion │<┼── Bye (optional)
  │ ╰────────────────────╯ │  
  │       Only once        │  
  │ ╭────────────────────╮ │  
──┼>│ receive Completion ├─┼─> Bye/ByeBack (required)
  │ ╰────────────────────╯ │  
  ╰────────────────────────╯  

---

• Sources

  1. Creating
     1. Empty
     2. Never
     3. ThrowError
     4. From
     5. Of
     6. Just
     7. Interval
     8. Timer
  2. Multicasting
     1. Share
     2. PublishSubject
     3. AsyncSubject
     4. BehaviorSubject
     5. ReplaySubject
  3. Others
     1. Pullable
     2. Iteratable

---

• Sinkers

  1. Assign
  2. Await
  3. ForEach
  4. Sink
  5. Observe

---

• Operators

  1. Combining
     1. Combine
     2. Concat
     3. Merge
     4. Race
     5. SwitchLatest
     6. Zip
  2. Debugging
     1. Breakpoint
     2. Debug
     3. Print
     4. Tap
  3. ErrorHandling
     1. Assert
     2. CatchError
     3. MapError
     4. Retry
  4. Filtering
     1. Distinct
     2. Filter
     3. Reject
     4. IgnoreElements
     5. First
     6. Last
     7. Drop
     8. Skip
     9. Take
  5. Matching
     1. AllSatisfy
     2. Contains
  6. Mathematical
     1. Average
     2. Count
     3. Max
     4. Min
     5. Sum
  7. Threading
     1. Async
     2. Sync
     3. Blocking
  8. Timing
     1. Debounce
     2. Throttle
     3. Durations
     4. Timestamps
     5. Timeout
     6. Delay
     7. Wait
  9. Transforming
     1. Indices
     2. Buffer
     3. Collect
     4. Codable
     5. Components
     6. Split
     7. Joined
     8. De-Materialize
     9. Map
     10. Compact
     11. FlatMap
     12. Pluck
     13. Group
     14. Partition
     15. Reduce
     16. Loop
     17. Scan
     18. Repeats
     19. Replace

---

• Pipes