SCFileStreamException.h

См. документацию.

//
//  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 Class Constants

#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 Class Support Types

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

typedef SCStreamError SCFileStreamError;

@interface SCFileStreamException : SCStreamException {
    SCFileStreamOpenMode        fOpenMode;  // Incorrect file stream opening mode
    SCSystemError               fSeekError; // File stream seeking system error code
    NSInteger                   fOffset;    // Incorrect file stream offset
    SCFileStreamOffsetWhence    fWhence;    // Incorrect file stream offset whence
}

#pragma mark -
#pragma mark Instance Properties

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

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

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

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

#pragma mark -
#pragma mark Instance Properties
- (SCFileStreamOpenMode)openMode;
- (SCSystemError)seekError;
- (NSInteger)offset;
- (SCFileStreamOffsetWhence)whence;

#pragma mark -
#pragma mark Creating and Initializing Incorrect Open Mode Exception (SCL-20033)
+ (instancetype)exceptionWithOpenMode:(SCFileStreamOpenMode)mode path:(NSString *)path;
+ (instancetype)exceptionWithOpenMode:(SCFileStreamOpenMode)mode;
- (instancetype)initWithOpenMode:(SCFileStreamOpenMode)mode path:(NSString *)path;
- (instancetype)initWithOpenMode:(SCFileStreamOpenMode)mode;

#pragma mark -
#pragma mark Creating and Initializing Empty Path Exception (SCL-20034)
+ (instancetype)exceptionWithEmptyPath;
- (instancetype)initWithEmptyPath;

#pragma mark -
#pragma mark Creating and Initializing End of Stream Exception (SCL-20035)
+ (instancetype)exceptionWithEndOfFile:(NSString *)file;
+ (instancetype)exceptionWithEndOfFile;
- (instancetype)initWithEndOfFile:(NSString *)file;
- (instancetype)initWithEndOfFile;

#pragma mark -
#pragma mark Creating and Initializing Offset Exception (SCL-20036 and SCL-20037)
+ (instancetype)exceptionWithSeekError:(SCSystemError)error
                                whence:(SCFileStreamOffsetWhence)whence
                                offset:(NSInteger)offset
                                  path:(NSString *)path;
+ (instancetype)exceptionWithSeekError:(SCSystemError)error
                                whence:(SCFileStreamOffsetWhence)whence
                                offset:(NSInteger)offset;
+ (instancetype)exceptionWithSeekError:(SCSystemError)error path:(NSString *)path;
+ (instancetype)exceptionWithSeekError:(SCSystemError)error;
+ (instancetype)exceptionWithWhence:(SCFileStreamOffsetWhence)whence path:(NSString *)path;
+ (instancetype)exceptionWithWhence:(SCFileStreamOffsetWhence)whence;
- (instancetype)initWithSeekError:(SCSystemError)error
                           whence:(SCFileStreamOffsetWhence)whence
                           offset:(NSInteger)offset
                             path:(NSString *)path;
- (instancetype)initWithSeekError:(SCSystemError)error whence:(SCFileStreamOffsetWhence)whence offset:(NSInteger)offset;
- (instancetype)initWithSeekError:(SCSystemError)error path:(NSString *)path;
- (instancetype)initWithSeekError:(SCSystemError)error;
- (instancetype)initWithWhence:(SCFileStreamOffsetWhence)whence path:(NSString *)path;
- (instancetype)initWithWhence:(SCFileStreamOffsetWhence)whence;

@end