Класс SCFileStream

Класс файловых потоков Подробнее...

#import <SCFileStream.h>

Граф наследования:SCFileStream:

Свойства экземпляра класса
SCFileStreamOpenMode	openMode

Создание файловых потоков
(instancetype)	+ fileStreamWithPath:mode:delegate:handling:
(instancetype)	+ fileStreamWithPath:mode:delegate:
(instancetype)	+ fileStreamWithPath:mode:
(instancetype)	+ fileStreamWithPath:
(instancetype)	+ readOnlyFileStreamWithPath:
(instancetype)	+ writeOnlyFileStreamWithPath:
(instancetype)	+ appendFileStreamWithPath:
(instancetype)	+ fileStream

Инициализация файловых потоков
(instancetype)	- initWithPath:mode:delegate:handling:
(instancetype)	- initWithPath:mode:delegate:
(instancetype)	- initWithPath:mode:
(instancetype)	- initWithPath:
(instancetype)	- initReadOnlyWithPath:
(instancetype)	- initWriteOnlyWithPath:
(instancetype)	- initAppendWithPath:
(instancetype)	- init

Чтение и запись данных
(SCSize)	- readBytes:toBuffer:
(SCSize)	- writeBytes:fromBuffer:

Открытие и закрытие потоков
(void)	- openWithPath:mode:handling:
(void)	- openWithPath:mode:
(void)	- openWithPath:
(void)	- openReadOnlyWithPath:
(void)	- openWriteOnlyWithPath:
(void)	- openAppendWithPath:
(void)	- close

Позиционирование в потоке
(void)	- setOffset:whence:
(void)	- setOffset:
(NSInteger)	- offset
(void)	- rewind

Дополнительные унаследованные члены
Методы экземпляра унаследованные от SCStream
(void)	- setErrorHandling:
(void)	- setDelegate:
(void)	- resetStats
(id)	- readObject
(SCByte)	- readByte
(SCUByte)	- readUByte
(SCShort)	- readShort
(SCUShort)	- readUShort
(SCInteger)	- readInteger
(SCUInteger)	- readUInteger
(SCLong)	- readLong
(SCULong)	- readULong
(char)	- readChar
(unichar)	- readUnichar
(const char *)	- readCharString
(BOOL)	- readBool
(SCFloat)	- readFloat
(SCDouble)	- readDouble
(NSInteger)	- readNSInteger
(NSUInteger)	- readNSUInteger
(SCSize)	- readToByte:
(SCSize)	- readToUByte:
(SCSize)	- readToShort:
(SCSize)	- readToUShort:
(SCSize)	- readToInteger:
(SCSize)	- readToUInteger:
(SCSize)	- readToLong:
(SCSize)	- readToULong:
(SCSize)	- readToChar:
(SCSize)	- readToUnichar:
(SCSize)	- readToCharString:max:
(SCSize)	- readToBool:
(SCSize)	- readToFloat:
(SCSize)	- readToDouble:
(SCSize)	- readToNSInteger:
(SCSize)	- readToNSUInteger:
(void)	- writeObject:
(void)	- writeByte:
(void)	- writeUByte:
(void)	- writeShort:
(void)	- writeUShort:
(void)	- writeInteger:
(void)	- writeUInteger:
(void)	- writeLong:
(void)	- writeULong:
(void)	- writeChar:
(void)	- writeUnichar:
(void)	- writeCharString:
(void)	- writeBool:
(void)	- writeFloat:
(void)	- writeDouble:
(void)	- writeNSInteger:
(void)	- writeNSUInteger:
(NSString *)	- readStringWithEncoding:
(NSString *)	- readStringWithMax:
(NSString *)	- readString
(void)	- writeString:
Методы экземпляра унаследованные от SCObject
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:
(BOOL)	- isEqual:
Свойства унаследованные от SCStream
SCStreamErrorHandling	errorHandling
SCStreamStatus	status
NSString *	name
BOOL	opened
BOOL	readable
BOOL	writable
BOOL	readOnly
BOOL	writeOnly
BOOL	readWrite
id	object
SCStreamException *	streamException
SCSystemException *	systemException
id< SCStreamDelegate >	delegate
BOOL	eof
SCULong	totalRead
SCULong	totalWrite
SCULong	lastRead
SCULong	lastWrite

Подробное описание

Класс файловых потоков

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Начиная с

версии 1.1.3

Является реализацией абстрактного класса SCStream, которая обеспечивает доступ к файловым потокам.
При работе с экземплярами класса могут возникать следующие ошибки:

• SCL-20002: системная ошибка
• SCL-20021: поток не открыт
• SCL-20022: поток открыт только для чтения
• SCL-20023: поток открыт только для записи
• SCL-20024: обнаружен неизвестный класс
• SCL-20025: обнаружен экземпляр класса неожиданного типа
• SCL-20026: обнаружен неподдерживаемый класс
• SCL-20027: операция чтения не завершена
• SCL-20028: операция записи не завершена
• SCL-20029: ошибка открытия потока
• SCL-20030: ошибка чтения данных
• SCL-20031: ошибка записи данных
• SCL-20032: ошибка класса NSNumber
• SCL-20033: некорректный режим открытия файлового потока
• SCL-20034: задан пустой путь к файловому потоку
• SCL-20035: обнаружен конец потока
• SCL-20036: некорректный размер смещения в потоке
• SCL-20037: некорректное направление смещения в потоке

Документация метода

+ (instancetype) appendFileStreamWithPath:

(NSString *)

path

Классовый метод создает файловый поток с заданным путем в режиме добавления данных.

Аргументы

path	- путь к файловому потоку

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) close

Метод закрывает файловый поток.

+ (instancetype) fileStream

Классовый метод создает файловый поток без параметров и не открывая его.

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

+ (instancetype) fileStreamWithPath:

(NSString *)

path

Классовый метод создает файловый поток с заданным путем в режиме чтения и записи.

Аргументы

path	- путь к файловому потоку

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

+ (instancetype) fileStreamWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode

Классовый метод создает файловый поток с заданными путем и режимом открытия.

Аргументы

path

- путь к файловому потоку

mode

- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

+ (instancetype) fileStreamWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode
delegate:		(id<SCStreamDelegate>)	delegate

Классовый метод создает файловый поток с заданными путем, режимом открытия и обработчиком событий.

Аргументы

path	- путь к файловому потоку
mode	- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных
delegate	- обработчик событий файлового потока

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

+ (instancetype) fileStreamWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode
delegate:		(id<SCStreamDelegate>)	delegate
handling:		(SCStreamErrorHandling)	handling

Классовый метод создает файловый поток с заданными путем, режимом открытия, обработчиком событий и режимом обработки ошибок.

Аргументы

path	- путь к файловому потоку
mode	- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных
delegate	- обработчик событий файлового потока
handling	- режим обработки ошибок файлового потока: SCStreamErrorHandlingSystem - генерируется исключительная ситуация системной ошибки SCStreamErrorHandlingStream - генерируется исключительная ситуация ошибки потока SCStreamErrorHandlingStatus - изменение статуса потока и вызов обработчика ошибок

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) init

Метод инициализирует файловый поток без его открытия и связи с каким-либо файлом.

Возвращает

Инициализированный файловый поток

Переопределяет метод предка SCStream.

- (instancetype) initAppendWithPath:

(NSString *)

path

Метод инициализирует файловый поток в режиме добавления данных с указанным путем к файлу.

Аргументы

path	- путь к файловому потоку

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initReadOnlyWithPath:

(NSString *)

path

Метод инициализирует файловый поток в режиме только для чтения с заданным путем к файлу.

Аргументы

path	- путь к файловому потоку

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initWithPath:

(NSString *)

path

Метод инициализирует файловый поток в режиме для чтения и записи с заданным путем к файлу.

Аргументы

path	- путь к файловому потоку

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode

Метод инициализирует файловый поток с заданными путем и режимом открытия. режимом обработки ошибок.

Аргументы

path

- путь к файловому потоку

mode

- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode
delegate:		(id<SCStreamDelegate>)	delegate

Метод инициализирует файловый поток с заданными путем, режимом открытия и обработчиком событий. режимом обработки ошибок.

Аргументы

path	- путь к файловому потоку
mode	- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных
delegate	- обработчик событий файлового потока

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode
delegate:		(id<SCStreamDelegate>)	delegate
handling:		(SCStreamErrorHandling)	handling

Метод инициализирует файловый поток с заданными путем, режимом открытия, обработчиком событий и режимом обработки ошибок.

Внимание

Является назначенным инициализатором класса

Аргументы

path	- путь к файловому потоку
mode	- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных
delegate	- обработчик событий файлового потока
handling	- режим обработки ошибок файлового потока: SCStreamErrorHandlingSystem - генерируется исключительная ситуация системной ошибки SCStreamErrorHandlingStream - генерируется исключительная ситуация ошибки потока SCStreamErrorHandlingStatus - изменение статуса потока и вызов обработчика ошибок

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (instancetype) initWriteOnlyWithPath:

(NSString *)

path

Метод инициализирует файловый поток в режиме только для записи с заданным путем к файлу.

Аргументы

path	- путь к файловому потоку

Возвращает

Инициализированный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (NSInteger) offset

Метод возвращает смещение в символах от начала потока.

Возвращает

Смещение в символах или -1 при обнаружении ошибки

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openAppendWithPath:

(NSString *)

path

Метод открывает файловый поток с заданным путем в режиме добавления данных.

Аргументы

path	- путь к файловому потоку

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openReadOnlyWithPath:

(NSString *)

path

Метод открывает файловый поток с заданным путем в режиме только для чтения.

Аргументы

path	- путь к файловому потоку

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openWithPath:

(NSString *)

path

Метод открывает файловый поток с заданным путем в режиме чтения и записи.

Аргументы

path	- путь к файловому потоку

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode

Метод открывает файловый поток с заданными путем и режимом открытия.

Аргументы

path

- путь к файловому потоку

mode

- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openWithPath:		(NSString *)	path
mode:		(SCFileStreamOpenMode)	mode
handling:		(SCStreamErrorHandling)	handling

Метод открывает файловый поток с заданными путем, режимом открытия и режимом обработки ошибок.

Аргументы

path	- путь к файловому потоку
mode	- режим открытия файлового потока: SCFileStreamOpenReadOnly - режим только для чтения SCFileStreamOpenReadWrite - режим чтения и записи SCFileStreamOpenWriteOnly - режим только для записи SCFileStreamOpenWriteRead - режим чтения и записи с удалением содержимого файла SCFileStreamOpenAppendWriteOnly - режим только для добавления данных SCFileStreamOpenAppendReadWrite - режим чтения и добавления данных
handling	- режим обработки ошибок файлового потока: SCStreamErrorHandlingSystem - генерируется исключительная ситуация системной ошибки SCStreamErrorHandlingStream - генерируется исключительная ситуация ошибки потока SCStreamErrorHandlingStatus - изменение статуса потока и вызов обработчика ошибок

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) openWriteOnlyWithPath:

(NSString *)

path

Метод открывает файловый поток с заданным путем в режиме только для записи.

Аргументы

path	- путь к файловому потоку

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (SCSize) readBytes:		(SCSize)	count
toBuffer:		(void *)	buffer

Метод считывает заданное количество байт в указанный буфер.

Аргументы

count	- число байт для считывания из потока
buffer	- указатель на буфер для считанных данных

Возвращает

Реально считанное из потока количество байт

Исключения

SCStreamException	- обнаружена ошибка потока
SCSystemException	- обнаружена системная ошибка

Переопределяет метод предка SCStream.

+ (instancetype) readOnlyFileStreamWithPath:

(NSString *)

path

Классовый метод создает файловый поток с заданным путем в режиме только для чтения.

Аргументы

path	- путь к файловому потоку

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) rewind

Метод устанавливает указатель потока в начало файла.

Исключения

SCStreamException

- обнаружена ошибка в работе файлового потока

- (void) setOffset:

(NSInteger)

offset

Метод перемещает указатель потока на заданное количество символов от начала потока.

Аргументы

offset

- смещение в потоке

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (void) setOffset:		(NSInteger)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Метод перемещает указатель потока в соответствии с заданным смещением и направлением смещения.

Аргументы

offset	- смещение в потоке
whence	- направление смещения: SCFileStreamOffsetStart - новая позиция вычисляется от начала потока SCFileStreamOffsetCurrent - новая позиция вычисляется от текущей позиции SCFileStreamOffsetEnd - новая позиция вычисляется от конца потока

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

- (SCSize) writeBytes:		(SCSize)	count
fromBuffer:		(const void *)	buffer

Метод записывает в поток заданное количество символов из указанного буфера.

Аргументы

count	- количество символов для записи в поток
buffer	- указатель на буфер с данными для записи

Возвращает

Реально записанное количество символов

Исключения

SCStreamException	- обнаружена ошибка потока
SCSystemException	- обнаружена системная ошибка

Переопределяет метод предка SCStream.

+ (instancetype) writeOnlyFileStreamWithPath:

(NSString *)

path

Классовый метод создает файловый поток с заданным путем в режиме только для записи.

Аргументы

path	- путь к файловому потоку

Возвращает

Созданный файловый поток

Исключения

SCStreamException	- обнаружена ошибка в работе файлового потока
SCSystemException	- обнаружена системная ошибка

Полный список свойств

- (SCFileStreamOpenMode) openMode

readnonatomicassign

Режим открытия файлового потока

---

Объявления и описания членов классов находятся в файлах:

• SCFileStream.h
• SCFileStream.m