skia2/include/utils/SkFrontBufferedStream.h
Joe Gregorio b25f30348b Revert "Move SkFrontBufferedStream into Android-only dir"
This reverts commit 513720f28e.

Reason for revert: Breaking the google3 roll:
   https://sponge.corp.google.com/invocation?tab=Build+Log&id=5f96970b-8171-4c2f-abf3-006e11b8fff9

Original change's description:
> Move SkFrontBufferedStream into Android-only dir
> 
> Bug: skia:10154
> 
> Add client_utils for code that is specifically for a single client.
> Move SkFrontBufferedStream into its android/ subdir. Rename the class
> to android::skia::FrontBufferedStream. Temporarily leave in
> SkFrontBufferedStream until Android updates to the new API.
> 
> Add a new optional target for client_utils/android. It is built in dev
> builds for testing, and when building for the Android framework.
> 
> Change-Id: Ie0f425051ea370aab7861d61150a3d6007214a93
> Reviewed-on: https://skia-review.googlesource.com/c/skia/+/284721
> Commit-Queue: Leon Scroggins <scroggo@google.com>
> Reviewed-by: Mike Reed <reed@google.com>
> Reviewed-by: Derek Sollenberger <djsollen@google.com>

TBR=djsollen@google.com,scroggo@google.com,reed@google.com

Change-Id: Iaeedaed184cc35f507d5441631ae709e1c5cb1ac
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: skia:10154
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/285100
Reviewed-by: Joe Gregorio <jcgregorio@google.com>
Commit-Queue: Joe Gregorio <jcgregorio@google.com>
2020-04-23 18:23:30 +00:00

40 lines
1.6 KiB
C++

/*
* Copyright 2013 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkFrontBufferedStream_DEFINED
#define SkFrontBufferedStream_DEFINED
#include "include/core/SkStream.h"
/**
* Specialized stream that buffers the first X bytes of a stream,
* where X is passed in by the user. Note that unlike some buffered
* stream APIs, once more bytes than can fit in the buffer are read,
* no more buffering is done. This stream is designed for a use case
* where the caller knows that rewind will only be called from within
* X bytes (inclusive), and the wrapped stream is not necessarily
* able to rewind at all.
*/
class SK_API SkFrontBufferedStream {
public:
/**
* Creates a new stream that wraps and buffers an SkStream.
* @param stream SkStream to buffer. If stream is NULL, NULL is
* returned. When this call succeeds (i.e. returns non NULL),
* SkFrontBufferedStream is expected to be the only owner of
* stream, so it should no be longer used directly.
* SkFrontBufferedStream will delete stream upon deletion.
* @param minBufferSize Minimum size of buffer required.
* @return An SkStream that can buffer at least minBufferSize, or
* NULL on failure. The caller is required to delete when finished with
* this object.
*/
static std::unique_ptr<SkStreamRewindable> Make(std::unique_ptr<SkStream> stream,
size_t minBufferSize);
};
#endif // SkFrontBufferedStream_DEFINED