NDEVR
API Documentation
BufferedScanner.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Base
28File: BufferedScanner
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/Scanner.h>
35namespace NDEVR
36{
43 class NDEVR_BASE_API BufferedScanner : public Scanner
44 {
45 public:
52 BufferedScanner(const File& file, char delimiter = '|', File::OpenMode mode = File::e_ascii_read);
58 explicit BufferedScanner(const StringView& string, char delimiter = '|');
65 bool nextLine(String& string, bool clear_string = true) final override;
71 void setFilePosition(uint08 file_position, bool read_line = true) final override;
76 uint01* getByteArray() final override;
81 bool nextLine() final override;
82 protected:
85 };
86}
87
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
void setFilePosition(uint08 file_position, bool read_line=true) final override
Sets the current read position within the buffered data.
BufferedScanner(const StringView &string, char delimiter='|')
Constructs a BufferedScanner from a string view, caching the contents for scanning.
uint01 * getByteArray() final override
Returns a pointer to the raw byte array at the current read position.
BufferedScanner(const File &file, char delimiter='|', File::OpenMode mode=File::e_ascii_read)
Constructs a BufferedScanner from a file, reading and caching the entire contents.
bool nextLine(String &string, bool clear_string=true) final override
Advances to the next line and writes it into the provided string.
Buffer< uint04 > m_new_lines
Indices of newline positions within the buffered data.
String m_file_buffer
The entire file or string contents cached in memory.
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53
OpenMode
Specifies the mode in which a file is opened.
Definition File.h:59
@ e_ascii_read
Open for ASCII text reading.
Definition File.h:62
File file() const
Returns the file associated with this scanner.
Definition Scanner.h:194
Scanner(const File &file, char delimiter='|', File::OpenMode mode=File::e_ascii_read)
Constructs a Scanner that reads from a file.
The core String View class for the NDEVR API.
Definition StringView.h:58
The core String class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.
uint64_t uint08
-Defines an alias representing an 8 byte, unsigned integer
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
uint8_t uint01
-Defines an alias representing a 1 byte, unsigned integer -Can represent exact integer values 0 throu...