skia2/include/utils/SkFrontBufferedStream.h
Derek Sollenberger 2fbf1bc8c9 Add SK_API to APIs used by the android framework.
This CL enables us to set the default visibility of the symbols
on Android to hidden.  It is the intent that all of he SK_APIs
that have been added to /src directies should be removed as soon
as we can remove their callers within Android.

Bug: b/31971097
Change-Id: Ic787f94df0fb0c2b8d941aa7095a12b317c4b5de
Reviewed-on: https://skia-review.googlesource.com/49501
Reviewed-by: Mike Reed <reed@google.com>
Commit-Queue: Derek Sollenberger <djsollen@google.com>
2017-09-21 18:14:36 +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 "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