[UniqueHandleDeclaration2Snippet] More...

#include <File.h>

Inheritance diagram for SC::FileDescriptor:

Public Types
enum	SeekMode { SeekStart , SeekEnd , SeekCurrent }
	How the offset to FileDescriptor::seek is defined. More...

Public Member Functions
Result	openForWriteToDevNull ()
	... [UniqueHandleDeclaration2Snippet]

Result	openStdOutDuplicate ()
	Opens a duplicated file descriptor handle for reading from stdout.

Result	openStdErrDuplicate ()
	Opens a duplicated file descriptor handle for reading from stderr.

Result	openStdInDuplicate ()
	Opens a duplicated file descriptor handle for reading from stdin.

Result	open (StringSpan path, FileOpen mode)
	Opens a file descriptor handle from a file system path.

Result	read (Span< char > data, Span< char > &actuallyRead, uint64_t offset)
	Reads bytes at offset into user supplied span.

Result	read (Span< uint8_t > data, Span< uint8_t > &actuallyRead, uint64_t offset)
	Reads bytes at offset into user supplied span.

Result	read (Span< char > data, Span< char > &actuallyRead)
	Reads bytes from current position (FileDescriptor::seek) into user supplied Span.

Result	read (Span< uint8_t > data, Span< uint8_t > &actuallyRead)
	Reads bytes from current position (FileDescriptor::seek) into user supplied Span.

template<typename T >
Result	readUntilEOF (T &destination)
	Reads into a given dynamic buffer until End of File (EOF) is signaled.

Result	readUntilEOF (IGrowableBuffer &&buffer)
	Reads into a given dynamic buffer until End of File (EOF) is signaled.

Result	writeString (StringSpan data)
	Writes a string to the file descriptor.

Result	write (Span< const char > data, uint64_t offset)
	Writes bytes at offset from start of the file descriptor.

Result	write (Span< const uint8_t > data, uint64_t offset)
	Writes bytes at offset from start of the file descriptor.

Result	write (Span< const char > data)
	Writes bytes from current position (FileDescriptor::seek) of the file descriptor.

Result	write (Span< const uint8_t > data)
	Writes bytes from current position (FileDescriptor::seek) of the file descriptor.

Result	seek (SeekMode seekMode, uint64_t offset)
	Changes the current position in the file descriptor, if seekable.

Result	currentPosition (size_t &position) const
	Gets current descriptor position (if seekable)

Result	sizeInBytes (size_t &sizeInBytes) const
	Gets total file size in bytes (if seekable)

	UniqueHandle ()=default

	UniqueHandle (const UniqueHandle &v)=delete

	UniqueHandle (UniqueHandle &&v)

	UniqueHandle (const Handle &externalHandle)

Friends
struct	File

struct	PipeDescriptor

Detailed Description

[UniqueHandleDeclaration2Snippet]

Open, read and write to/from a file descriptor (like a file or pipe).

Member Enumeration Documentation

◆ SeekMode

enum SC::FileDescriptor::SeekMode

How the offset to FileDescriptor::seek is defined.

Enumerator
SeekStart	Offset to FileDescriptor::seek is to be applied from start of descriptor.
SeekEnd	Offset to FileDescriptor::seek is to be applied (backwards) from end of descriptor.
SeekCurrent	Offset to FileDescriptor::seek is to be applied from current descriptor position.

Member Function Documentation

◆ currentPosition()

Result SC::FileDescriptor::currentPosition ( size_t & position ) const

Gets current descriptor position (if seekable)

Parameters

position (output) current position of file descriptor

Returns: Valid result if seek succeeds

◆ open()

Result SC::FileDescriptor::open	(	StringSpan	path,
		FileOpen	mode )

Opens a file descriptor handle from a file system path.

Parameters

path	The absolute path to file. It MUST be encoded in ASCII,UTF-8/16 on Windows, ASCII,UTF-8 on POSIX.
mode	The mode used to open file (read-only, write-append etc.)

Returns: Valid Result if file is opened successfully

◆ openForWriteToDevNull()

Result SC::FileDescriptor::openForWriteToDevNull ( )

... [UniqueHandleDeclaration2Snippet]

Opens a file descriptor handle for writing to /dev/null or equivalent on current OS.

Returns: true if file has been opened successfully

◆ openStdErrDuplicate()

Result SC::FileDescriptor::openStdErrDuplicate ( )

Opens a duplicated file descriptor handle for reading from stderr.

Note: The returned handle CAN be closed because it will be a duplicate of the original handle.

◆ openStdInDuplicate()

Result SC::FileDescriptor::openStdInDuplicate ( )

Opens a duplicated file descriptor handle for reading from stdin.

Note: The returned handle CAN be closed because it will be a duplicate of the original handle.

◆ openStdOutDuplicate()

Result SC::FileDescriptor::openStdOutDuplicate ( )

Opens a duplicated file descriptor handle for reading from stdout.

Note: The returned handle CAN be closed because it will be a duplicate of the original handle.

◆ read() [1/4]

Result SC::FileDescriptor::read	(	Span< char >	data,
		Span< char > &	actuallyRead )

Reads bytes from current position (FileDescriptor::seek) into user supplied Span.

Parameters

data	Span of bytes where data should be written to
actuallyRead	A sub-span of data of the actually read bytes. A zero sized span means EOF.

Returns: Valid result if read succeeded

◆ read() [2/4]

Result SC::FileDescriptor::read	(	Span< char >	data,
		Span< char > &	actuallyRead,
		uint64_t	offset )

Reads bytes at offset into user supplied span.

Parameters

data	Span of bytes where data should be written to
actuallyRead	A sub-span of data of the actually read bytes. A zero sized span means EOF.
offset	Offset from begin of the file descriptor where read should be started

Returns: Valid result if read succeeded

◆ read() [3/4]

Result SC::FileDescriptor::read	(	Span< uint8_t >	data,
		Span< uint8_t > &	actuallyRead )

Reads bytes from current position (FileDescriptor::seek) into user supplied Span.

Parameters

data	Span of bytes where data should be written to
actuallyRead	A sub-span of data of the actually read bytes. A zero sized span means EOF.

Returns: Valid result if read succeeded

◆ read() [4/4]

Result SC::FileDescriptor::read	(	Span< uint8_t >	data,
		Span< uint8_t > &	actuallyRead,
		uint64_t	offset )

Reads bytes at offset into user supplied span.

Parameters

data	Span of bytes where data should be written to
actuallyRead	A sub-span of data of the actually read bytes. A zero sized span means EOF.
offset	Offset from begin of the file descriptor where read should be started

Returns: Valid result if read succeeded

◆ readUntilEOF() [1/2]

Result SC::FileDescriptor::readUntilEOF ( IGrowableBuffer && buffer )

Reads into a given dynamic buffer until End of File (EOF) is signaled.

It works also for non-seekable file descriptors (stdout / in / err).

Parameters

buffer A destination buffer to write to (it will be resized as needed)

Returns: Valid result if read succeeded until EOF

◆ readUntilEOF() [2/2]

template<typename T >

Result SC::FileDescriptor::readUntilEOF ( T & destination )

inline

Reads into a given dynamic buffer until End of File (EOF) is signaled.

It works also for non-seekable file descriptors (stdout / in / err).

Template Parameters

T	Type of the destination buffer implementing IGrowableBuffer interface (String, SmallString, Buffer)

Parameters

destination A destination buffer to write to (it will be resized as needed)

Returns: Valid result if read succeeded until EOF

◆ seek()

Result SC::FileDescriptor::seek	(	SeekMode	seekMode,
		uint64_t	offset )

Changes the current position in the file descriptor, if seekable.

Parameters

seekMode	How the offset is defined (from start, end, current)
offset	An offset to be applied according to seekMode to this descriptor

Returns: Valid result if seek succeeds

◆ sizeInBytes()

Result SC::FileDescriptor::sizeInBytes ( size_t & sizeInBytes ) const

Gets total file size in bytes (if seekable)

Parameters

sizeInBytes (output) total size of file

Returns: Valid result if seek succeeds

◆ write() [1/4]

Result SC::FileDescriptor::write ( Span< const char > data )

Writes bytes from current position (FileDescriptor::seek) of the file descriptor.

Parameters

data	Span of bytes containing the data to write

Returns: Valid result if write succeeded

◆ write() [2/4]

Result SC::FileDescriptor::write	(	Span< const char >	data,
		uint64_t	offset )

Writes bytes at offset from start of the file descriptor.

Parameters

data	Span of bytes containing the data to write
offset	Offset from begin of file descriptor to start writing

Returns: Valid result if write succeeded

◆ write() [3/4]

Result SC::FileDescriptor::write ( Span< const uint8_t > data )

Writes bytes from current position (FileDescriptor::seek) of the file descriptor.

Parameters

data	Span of bytes containing the data to write

Returns: Valid result if write succeeded

◆ write() [4/4]

Result SC::FileDescriptor::write	(	Span< const uint8_t >	data,
		uint64_t	offset )

Writes bytes at offset from start of the file descriptor.

Parameters

data	Span of bytes containing the data to write
offset	Offset from begin of file descriptor to start writing

Returns: Valid result if write succeeded

◆ writeString()

Result SC::FileDescriptor::writeString ( StringSpan data )

Writes a string to the file descriptor.

Parameters

data	The string data to write

Returns: Valid result if write succeeded

The documentation for this struct was generated from the following file:

File.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ SeekMode

Member Function Documentation

◆ currentPosition()

◆ open()

◆ openForWriteToDevNull()

◆ openStdErrDuplicate()

◆ openStdInDuplicate()

◆ openStdOutDuplicate()

◆ read() [1/4]

◆ read() [2/4]

◆ read() [3/4]

◆ read() [4/4]

◆ readUntilEOF() [1/2]

◆ readUntilEOF() [2/2]

◆ seek()

◆ sizeInBytes()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ writeString()