/**
|
* @license
|
* Copyright 2018 Google LLC. All Rights Reserved.
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*
|
* =============================================================================
|
*/
|
/// <amd-module name="@tensorflow/tfjs-data/dist/iterators/string_iterator" />
|
import { LazyIterator } from './lazy_iterator';
|
export declare abstract class StringIterator extends LazyIterator<string> {
|
/**
|
* Splits a string stream on a given separator.
|
*
|
* It is assumed that the incoming chunk boundaries have no semantic meaning,
|
* so conceptually the incoming stream is treated simply as the concatenation
|
* of its elements.
|
*
|
* The outgoing stream provides chunks corresponding to the results of the
|
* standard string split() operation (even if such a chunk spanned incoming
|
* chunks). The separators are not included.
|
*
|
* A typical usage is to split a text file (represented as a stream with
|
* arbitrary chunk boundaries) into lines.
|
*
|
* @param upstream A readable stream of strings that can be treated as
|
* concatenated.
|
* @param separator A character to split on.
|
*/
|
split(separator: string): StringIterator;
|
}
|
