Jorge Canizales | e8304d5 | 2015-02-17 19:50:51 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Yang Gao | 5fc9029 | 2015-02-20 09:46:22 -0800 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Jorge Canizales | e8304d5 | 2015-02-17 19:50:51 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 34 | #import "GRXWriter.h" |
| 35 | |
| 36 | @interface GRXWriter (Immediate) |
| 37 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 38 | /** |
| 39 | * Returns a writer that pulls values from the passed NSEnumerator instance and pushes them to |
| 40 | * its writeable. The NSEnumerator is released when it finishes. |
| 41 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 42 | + (instancetype)writerWithEnumerator:(NSEnumerator *)enumerator; |
| 43 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 44 | /** |
| 45 | * Returns a writer that pushes to its writeable the successive values returned by the passed |
| 46 | * block. When the block first returns nil, it is released. |
| 47 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 48 | + (instancetype)writerWithValueSupplier:(id (^)())block; |
| 49 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 50 | /** |
| 51 | * Returns a writer that iterates over the values of the passed container and pushes them to |
| 52 | * its writeable. The container is released when the iteration is over. |
| 53 | * |
| 54 | * Note that the usual speed gain of NSFastEnumeration over NSEnumerator results from not having to |
| 55 | * call one method per element. Because GRXWriteable instances accept values one by one, that speed |
| 56 | * gain doesn't happen here. |
| 57 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 58 | + (instancetype)writerWithContainer:(id<NSFastEnumeration>)container; |
| 59 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 60 | /** |
| 61 | * Returns a writer that sends the passed value to its writeable and then finishes (releasing the |
| 62 | * value). |
| 63 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 64 | + (instancetype)writerWithValue:(id)value; |
| 65 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Returns a writer that, as part of its start method, sends the passed error to the writeable |
| 68 | * (then releasing the error). |
| 69 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 70 | + (instancetype)writerWithError:(NSError *)error; |
| 71 | |
Jorge Canizales | b10776c | 2015-10-26 10:44:55 -0700 | [diff] [blame] | 72 | /** |
| 73 | * Returns a writer that, as part of its start method, finishes immediately without sending any |
| 74 | * values to its writeable. |
| 75 | */ |
Jorge Canizales | 30697c9 | 2015-02-17 17:09:14 -0800 | [diff] [blame] | 76 | + (instancetype)emptyWriter; |
| 77 | |
| 78 | @end |