forked
Stream Class Reference
[Platform]
File stream. More...
#include <Stream.h>
Inherits mbed::FileLike, and NonCopyable< Stream >.
Inherited by Serial.
Public Member Functions | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by FileHandle::seek") virtual off_t lseek(off_t offset | |
Move the file position to a given offset from a given location. | |
Protected Member Functions | |
virtual int | close () |
Close a file. | |
virtual ssize_t | write (const void *buffer, size_t length) |
Write the contents of a buffer to a file. | |
virtual ssize_t | read (void *buffer, size_t length) |
Read the contents of a file into a buffer. | |
virtual off_t | seek (off_t offset, int whence) |
Move the file position to a given offset from from a given location. | |
virtual off_t | tell () |
Get the file position of the file. | |
virtual void | rewind () |
Rewind the file position to the beginning of the file. | |
virtual int | isatty () |
Check if the file in an interactive terminal device. | |
virtual int | sync () |
Flush any buffers associated with the file. | |
virtual off_t | size () |
Get the size of the file. | |
virtual void | lock () |
Acquire exclusive access to this object. | |
virtual void | unlock () |
Release exclusive access to this object. |
Detailed Description
File stream.
- Note:
- Synchronization level: Set by subclass
Definition at line 40 of file Stream.h.
Member Function Documentation
int close | ( | ) | [protected, virtual] |
Close a file.
- Returns:
- 0 on success, negative error code on failure
Implements FileHandle.
Definition at line 70 of file Stream.cpp.
int isatty | ( | ) | [protected, virtual] |
Check if the file in an interactive terminal device.
- Returns:
- True if the file is a terminal
- False if the file is not a terminal
- Negative error code on failure
Reimplemented from FileHandle.
Definition at line 115 of file Stream.cpp.
virtual void lock | ( | void | ) | [protected, virtual] |
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | , |
"Replaced by FileHandle::seek" | |||
) | [inherited] |
Move the file position to a given offset from a given location.
- Parameters:
-
offset The offset from whence to move to whence SEEK_SET for the start of the file, SEEK_CUR for the current file position, or SEEK_END for the end of the file.
- Returns:
- new file position on success, -1 on failure or unsupported
ssize_t read | ( | void * | buffer, |
size_t | size | ||
) | [protected, virtual] |
Read the contents of a file into a buffer.
Devices acting as FileHandles should follow POSIX semantics:
* if no data is available, and non-blocking set return -EAGAIN * if no data is available, and blocking set, wait until data is available * If any data is available, call returns immediately
- Parameters:
-
buffer The buffer to read in to size The number of bytes to read
- Returns:
- The number of bytes read, 0 at end of file, negative error on failure
Implements FileHandle.
Definition at line 89 of file Stream.cpp.
void rewind | ( | ) | [protected, virtual] |
Rewind the file position to the beginning of the file.
- Note:
- This is equivalent to seek(0, SEEK_SET)
Reimplemented from FileHandle.
Definition at line 112 of file Stream.cpp.
off_t seek | ( | off_t | offset, |
int | whence | ||
) | [protected, virtual] |
Move the file position to a given offset from from a given location.
- Parameters:
-
offset The offset from whence to move to whence The start of where to seek SEEK_SET to start from beginning of file, SEEK_CUR to start from current position in file, SEEK_END to start from end of file
- Returns:
- The new offset of the file, negative error code on failure
Implements FileHandle.
Definition at line 104 of file Stream.cpp.
off_t size | ( | ) | [protected, virtual] |
Get the size of the file.
- Returns:
- Size of the file in bytes
Reimplemented from FileHandle.
Definition at line 123 of file Stream.cpp.
int sync | ( | ) | [protected, virtual] |
Flush any buffers associated with the file.
- Returns:
- 0 on success, negative error code on failure
Reimplemented from FileHandle.
Definition at line 119 of file Stream.cpp.
off_t tell | ( | ) | [protected, virtual] |
Get the file position of the file.
- Note:
- This is equivalent to seek(0, SEEK_CUR)
- Returns:
- The current offset in the file, negative error code on failure
Reimplemented from FileHandle.
Definition at line 108 of file Stream.cpp.
virtual void unlock | ( | void | ) | [protected, virtual] |
ssize_t write | ( | const void * | buffer, |
size_t | size | ||
) | [protected, virtual] |
Write the contents of a buffer to a file.
- Parameters:
-
buffer The buffer to write from size The number of bytes to write
- Returns:
- The number of bytes written, negative error on failure
Implements FileHandle.
Definition at line 74 of file Stream.cpp.
Generated on Tue Jul 12 2022 16:02:36 by 1.7.2