summaryrefslogtreecommitdiff
path: root/src/stable/staticmembuf.h
blob: f168de355602b2f52df2bfa6c2105a5bff78db59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * Copyright (C) 2007-2011 Xagasoft, All rights reserved.
 *
 * This file is part of the libbu++ library and is released under the
 * terms of the license contained in the file LICENSE.
 */

#ifndef BU_STATIC_MEM_BUF_H
#define BU_STATIC_MEM_BUF_H

#include <stdint.h>

#include "bu/config.h"
#include "bu/stream.h"

namespace Bu
{
	/**
	 * An immutable, read-only memory buffer.  Construct this buffer around a
	 * block of raw memory, provide the length of the block, and you can read
	 * from that block via this class as though it were a normal stream.
	 *
	 * Use this class instead of MemBuf when you have a string already, and
	 * don't need to change it.  MemBuf will make a copy of your string for
	 * it's own use (often) and this will not (ever).
	 *@ingroup Streams
	 */
	class StaticMemBuf : public Stream
	{
	public:
		StaticMemBuf( const void *pData, size iSize );
		virtual ~StaticMemBuf();

		virtual void close();
		virtual size read( void *pBuf, size iBytes );

		virtual size write( const void *pBuf, size iBytes );
		using Stream::write;
		virtual size tell();
		virtual void seek( size offset );
		virtual void setPos( size pos );
		virtual void setPosEnd( size pos );
		virtual bool isEos();
		virtual bool isOpen();
		virtual void flush();
		virtual bool canRead();
		virtual bool canWrite();
		virtual bool isReadable();
		virtual bool isWritable();
		virtual bool isSeekable();
		virtual bool isBlocking();
		virtual void setBlocking( bool bBlocking=true );
		virtual void setSize( size iSize );
		virtual size getSize() const;
		virtual size getBlockSize() const;
		virtual Bu::String getLocation() const;

	private:
		const void *pData;
		size iSize;
		size nPos;
	};
}

#endif