SCFileStreamException.h

Go to the documentation of this file.

//
//  SCFileStreamException.h
//  scl
//
//  Created by Viacheslav Smolensky on 30.03.12.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCStreamException.h>
#import <scl/SCFileStream.h>

#pragma mark -
#pragma mark Константы класса

#define SCFileStreamExceptionClass  @"SCFileStreamException"

#pragma mark -
#pragma mark Error ID constants

#define SCFileStreamEIDOpenMode     @"SCL-20033"
#define SCFileStreamEIDEmptyPath    @"SCL-20034"
#define SCFileStreamEIDEOF          @"SCL-20035"
#define SCFileStreamEIDOffset       @"SCL-20036"
#define SCFileStreamEIDOffsetWhence @"SCL-20037"                

#pragma mark -
#pragma mark Типы поддержки класса

enum _SCFileStreamError {
    SCFileStreamErrorOpenMode       = -20033,
    SCFileStreamErrorEmptyPath      = -20034,
    SCFileStreamErrorEOF            = -20035,
    SCFileStreamErrorOffset         = -20036,
    SCFileStreamErrorOffsetWhence   = -20037,
};

typedef SCStreamError SCFileStreamError;

@interface SCFileStreamException : SCStreamException {
    SCFileStreamOpenMode        fOpenMode;  // Некорректный режим открытия файлового потока
    SCSystemError               fSeekError; // Код системной ошибки при выполнении позиционирования в потока
    SCLong                      fOffset;    // Некорректное смещение
    SCFileStreamOffsetWhence    fWhence;    // Некорректное направление смещения в потоке
}

#pragma mark -
#pragma mark Свойства экземпляра класса

@property (assign, readonly, getter=openMode) SCFileStreamOpenMode openMode;

@property (assign, readonly, getter=seekError) SCSystemError seekError;

@property (assign, readonly, getter=offset) SCLong offset;

@property (assign, readonly, getter=whence) SCFileStreamOffsetWhence whence;

#pragma mark -
#pragma mark Методы доступа к свойствам экземпляра класса
- (SCFileStreamOpenMode)openMode;
- (SCSystemError)seekError;
- (SCLong)offset;
- (SCFileStreamOffsetWhence)whence;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации некорректного режима открытия потока
+ (SCFileStreamException *)exceptionWithOpenMode:(SCFileStreamOpenMode)mode path:(NSString *)path;
+ (SCFileStreamException *)exceptionWithOpenMode:(SCFileStreamOpenMode)mode;
- (id)initWithOpenMode:(SCFileStreamOpenMode)mode path:(NSString *)path;
- (id)initWithOpenMode:(SCFileStreamOpenMode)mode;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации пустого пути файлового потока
+ (SCFileStreamException *)exceptionWithEmptyPath;
- (id)initWithEmptyPath;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации обнаружения конца файлового потока
+ (SCFileStreamException *)exceptionWithEndOfFile:(NSString *)file;
+ (SCFileStreamException *)exceptionWithEndOfFile;
- (id)initWithEndOfFile:(NSString *)file;
- (id)initWithEndOfFile;

#pragma mark -
#pragma mark Создание и инициализация исключительных ситуаций при позиционировании в потоке
+ (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error
                                           whence:(SCFileStreamOffsetWhence)whence
                                           offset:(SCLong)offset
                                             path:(NSString *)path;
+ (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error
                                           whence:(SCFileStreamOffsetWhence)whence
                                           offset:(SCLong)offset;
+ (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error path:(NSString *)path;
+ (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error;
+ (SCFileStreamException *)exceptionWithWhence:(SCFileStreamOffsetWhence)whence path:(NSString *)path;
+ (SCFileStreamException *)exceptionWithWhence:(SCFileStreamOffsetWhence)whence;
- (id)initWithSeekError:(SCSystemError)error
                 whence:(SCFileStreamOffsetWhence)whence
                 offset:(SCLong)offset
                   path:(NSString *)path;
- (id)initWithSeekError:(SCSystemError)error whence:(SCFileStreamOffsetWhence)whence offset:(SCLong)offset;
- (id)initWithSeekError:(SCSystemError)error path:(NSString *)path;
- (id)initWithSeekError:(SCSystemError)error;
- (id)initWithWhence:(SCFileStreamOffsetWhence)whence path:(NSString *)path;
- (id)initWithWhence:(SCFileStreamOffsetWhence)whence;

@end