Exception class SCStreamException.
More...
#import <SCStreamException.h>
Exception class SCStreamException.
- SDK
- macOS 10.6+, iOS 7.0+, GNUstep
- Since
- version 1.1.3
Declares the stream common exceptions.
Generated by the class exceptions correspond to the following errors:
+ (instancetype) exception |
|
|
|
Returns a generic stream exception created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithEmptyPath |
|
|
|
Returns an empty file stream path exception SCL-20034 created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithEndOfFile |
|
|
|
Returns an end of stream exception SCL-20035 created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithEndOfFile: |
|
(NSString *) |
file |
|
Returns an end of stream exception SCL-20035 created by using the specified file stream name.
- Parameters
-
file | - the name of the file stream |
- Returns
- A created exception
+ (instancetype) exceptionWithNotOpen |
|
|
|
Returns a not open stream exception SCL-20021 created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithNotOpenStream: |
|
(NSString *) |
stream |
|
Returns a not open stream exception SCL-20021 created by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithOpenError: |
|
(SCInteger) |
error |
|
Returns a stream opening exception SCL-20029 created by using the specified error code.
- Parameters
-
error | - the detected error code |
- Returns
- A created exception
Returns a stream opening exception SCL-20029 created by using the specified error code and erroneous stream name.
- Parameters
-
error | - the detected error code |
stream | - the name of the erroneous stream |
- Returns
- A created exception
Returns an incorrect open mode exception SCL-20033 created by using the specified incorrect mode.
- Parameters
-
mode | - the incorrect open mode |
- Returns
- A created exception
Returns an incorrect open mode exception SCL-20033 created by using the specified incorrect mode and file stream path.
- Parameters
-
mode | - the incorrect open mode |
path | - the path to the file stream |
- Returns
- A created exception
+ (instancetype) exceptionWithReaded: |
|
(SCSize) |
readed |
waited: |
|
(SCSize) |
waited |
|
|
| |
Returns an incompleted reading operation SCL-20027 created by using the specified number of actually readed bytes and number of waited bytes.
- Parameters
-
readed | - the number of the actually readed bytes |
waited | - the number of the required bytes during the reading operation |
- Returns
- A created exception
+ (instancetype) exceptionWithReaded: |
|
(SCSize) |
readed |
waited: |
|
(SCSize) |
waited |
stream: |
|
(NSString *) |
stream |
|
|
| |
Returns an incompleted reading operation SCL-20027 created by using the specified number of actually readed bytes, number of waited bytes and erroneous stream name.
- Parameters
-
readed | - the number of the actually readed bytes |
waited | - the number of the required bytes during the reading operation |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithReadError: |
|
(SCInteger) |
error |
|
Returns a reading exception SCL-20030 created by using the specified error code.
- Parameters
-
error | - the reading error code |
- Returns
- A created exception
Returns a reading exception SCL-20030 created by using the specified error code and stream name.
- Parameters
-
error | - the reading error code |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithReadOnly |
|
|
|
Returns a read only stream exception SCL-20022 created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithReadOnlyStream: |
|
(NSString *) |
stream |
|
Returns a read only stream exception SCL-20022 created by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithReason: |
|
(NSString *) |
reason |
code: |
|
(SCInteger) |
code |
eid: |
|
(NSString *) |
eid |
|
|
| |
Returns an exception created by using the specified error description, error code and error ID.
- Parameters
-
reason | - the error description |
code | - the code of the detected error |
eid | - the error ID |
- Returns
- A created exception
Returns a seeking exception SCL-20036 created by using the specified seeking error code.
- Parameters
-
error | - the seeking error code |
- Returns
- A created exception
Returns a seeking exception SCL-20036 created by using the specified seeking error code and file stream path.
- Parameters
-
error | - the seeking error code |
path | - the path to the file stream |
- Returns
- A created exception
Returns a seeking exception SCL-20036 created by using the specified seeking error code, seeking offset whence and seeking offset.
- Parameters
-
error | - the seeking error code |
whence | - the seeking offset whence |
offset | - the seeking offset |
- Returns
- A created exception
Returns a seeking exception SCL-20036 created by using the specified seeking error code, seeking offset whence, seeking offset and path to the file stream.
- Parameters
-
error | - the seeking error code |
whence | - the seeking offset whence |
offset | - the seeking offset |
path | - the file stream path |
- Returns
- A created exception
+ (instancetype) exceptionWithStream: |
|
(NSString *) |
stream |
|
Returns a generic stream exception created by using the specified stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A created exception
Returns an exception created by using the specified stream name, errod description, error code and error ID.
- Parameters
-
stream | - the name of the erroneous stream |
reason | - the error description |
code | - the code of the detected error |
eid | - the error ID |
- Returns
- A created exception
+ (instancetype) exceptionWithUnexpected: |
|
(NSString *) |
unexpected |
expected: |
|
(NSString *) |
expected |
|
|
| |
Returns an unexpected class exception SCL-20025 created by using the specified unexpected class name and expected class name.
- Parameters
-
unexpected | - the unexpected class name |
expected | - the expected class name |
- Returns
- A created exception
+ (instancetype) exceptionWithUnexpected: |
|
(NSString *) |
unexpected |
expected: |
|
(NSString *) |
expected |
stream: |
|
(NSString *) |
stream |
|
|
| |
Returns an unexpected class exception SCL-20025 created by using the specified unexpected class name, expected class name and erroneous stream name.
- Parameters
-
unexpected | - the unexpected class name |
expected | - the expected class name |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithUnknown: |
|
(NSString *) |
name |
|
Returns an unknown class exception SCL-20024 created by using the specified unknown class name.
- Parameters
-
name | - the unknown class name |
- Returns
- A created exception
Returns an unknown class exception SCL-20024 created by using the specified unknown class name and erroneous stream name.
- Parameters
-
name | - the unknown class name |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithUnsupported: |
|
(NSString *) |
name |
|
Returns an unsupported class exception SCL-20026 created by using the specified unsupported class name.
- Parameters
-
name | - the unsupported class name |
- Returns
- A created exception
Returns an unsupported class exception SCL-20026 created by using the specified unsupported class name and erroneous stream name.
- Parameters
-
name | - the unsupported class name |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithUnsupportedNumberType: |
|
(NSString *) |
type |
|
Returns a number object exception SCL-20032 created by using the specified unsupported number object type.
- Parameters
-
type | - the type of the unsupported object number |
- Returns
- A created exception
Returns a number object exception SCL-20032 created by using the specified type of the unsupported number object and erroneous stream name.
- Parameters
-
type | - the unsupported number object type |
stream | - the name of the erroneous stream |
- Returns
- A created exception
Returns an incorrect offset whence exception SCL-20037 created by using the specified incorrect offset whence.
- Parameters
-
whence | - the incorrect offset whence |
- Returns
- A created exception
Returns an incorrect offset whence exception SCL-20037 created by using the specified incorrect offset whence and file stream path.
- Parameters
-
whence | - the incorrect offset whence |
path | - the path to the file stream |
- Returns
- A created exception
+ (instancetype) exceptionWithWrited: |
|
(SCSize) |
writed |
waited: |
|
(SCSize) |
waited |
|
|
| |
Returns an incompleted writing operation SCL-20028 created by using the specified number of actually writed bytes and number of waited bytes.
- Parameters
-
writed | - the number of the actually writed bytes |
waited | - the number of the waited bytes |
- Returns
- A created exception
+ (instancetype) exceptionWithWrited: |
|
(SCSize) |
writed |
waited: |
|
(SCSize) |
waited |
stream: |
|
(NSString *) |
stream |
|
|
| |
Returns an incompleted writing operation SCL-20028 created by using the specified number of actually writed bytes, number of waited bytes and erroneous stream name.
- Parameters
-
writed | - the number of the actually writed bytes |
waited | - the number of the waited bytes |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithWriteError: |
|
(SCInteger) |
error |
|
Returns a writing exception SCL-20031 created by using the specified writing error code.
- Parameters
-
error | - the writing error code |
- Returns
- A created exception
Returns a writing exception SCL-20031 created by using the specified writing error code and erroneous stream name.
- Parameters
-
error | - the writing error code |
stream | - the name of the erroneous stream |
- Returns
- A created exception
+ (instancetype) exceptionWithWriteOnly |
|
|
|
Returns a write only stream exception SCL-20023 created by using the default settings.
- Returns
- A created exception
+ (instancetype) exceptionWithWriteOnlyStream: |
|
(NSString *) |
stream |
|
Returns a write only stream exception SCL-20023 created by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A created exception
Initializes a generic stream exception using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithEmptyPath |
|
|
|
Initializes an empty file stream path exception SCL-20034 by using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithEndOfFile |
|
|
|
Initializes an end of stream exception SCL-20035 by using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithEndOfFile: |
|
(NSString *) |
file |
|
Initializes an end of stream exception SCL-20035 by using the specified file stream name.
- Parameters
-
file | - the name of the file stream |
- Returns
- A newly initialized exception
- (instancetype) initWithNotOpen |
|
|
|
Initializes a not open stream exception SCL-20021 by using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithNotOpenStream: |
|
(NSString *) |
stream |
|
Initializes a not open stream exception SCL-20021 by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithOpenError: |
|
(SCInteger) |
error |
|
Initializes a stream opening exception SCL-20029 by using the specified error code.
- Parameters
-
error | - the opening error code |
- Returns
- A newly initialized exception
Initializes a stream opening exception SCL-20029 by using the specified error code and erroneous stream name.
- Parameters
-
error | - the code of the detected error |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
Initializes an incorrect open mode exception SCL-20033 by using the specified incorrect mode.
- Parameters
-
mode | - the incorrect open mode |
- Returns
- A newly initialized exception
Initializes an incorrect open mode exception SCL-20033 by using the specified incorrect mode and file stream path.
- Parameters
-
mode | - the incorrect open mode |
path | - the path to the file stream |
- Returns
- A newly initialized exception
- (instancetype) initWithReaded: |
|
(SCSize) |
readed |
waited: |
|
(SCSize) |
waited |
|
|
| |
Initializes an incomplited reading operation SCL-20027 by using the specified number of actually readed bytes and number of waited bytes.
- Parameters
-
readed | - the number of the actually readed bytes |
waited | - the number of the required bytes |
- Returns
- A newly initialized exception
- (instancetype) initWithReaded: |
|
(SCSize) |
readed |
waited: |
|
(SCSize) |
waited |
stream: |
|
(NSString *) |
stream |
|
|
| |
Initializes an incomplited reading operation SCL-20027 by using the specified number of actually readed bytes, number of waited bytes and erroneous stream name.
- Parameters
-
readed | - the number of the actually readed bytes |
waited | - the number of the required bytes |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithReadError: |
|
(SCInteger) |
error |
|
Initializes a reading exception SCL-20030 by using the specified error code.
- Parameters
-
error | - the reading error code |
- Returns
- A newly initialized exception
Initializes a reading exception SCL-20030 by using the specified error code and stream name.
- Parameters
-
error | - the reading error code |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithReadOnly |
|
|
|
Initializes a read only stream exception SCL-20022 by using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithReadOnlyStream: |
|
(NSString *) |
stream |
|
Initializes a read only stream exception SCL-20022 by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithReason: |
|
(NSString *) |
reason |
code: |
|
(SCInteger) |
code |
eid: |
|
(NSString *) |
eid |
|
|
| |
Initializes an exception using the specified error description, error code and error ID.
- Parameters
-
reason | - the error description |
code | - the code of the detected error |
eid | - the error ID |
- Returns
- A newly initialized exception
Initializes a seeking exception SCL-20036 by using the specified seeking error code.
- Parameters
-
error | - the seeking error code |
- Returns
- A newly initialized exception
Initializes a seeking exception SCL-20036 by using the specified seeking error code and file stream path.
- Parameters
-
error | - the seeking error code |
path | - the path to the file stream |
- Returns
- A newly initialized exception
Initializes a seeking exception SCL-20036 by using the specified seeking error code, seeking offset whence and seeking offset.
- Parameters
-
error | - the seeking error code |
whence | - the seeking offset whence |
offset | - the seeking offset |
- Returns
- A newly initialized exception
Initializes a seeking exception SCL-20036 by using the specified seeking error code, seeking offset whence, seeking offset and path to the file stream.
- Parameters
-
error | - the seeking error code |
whence | - the seeking offset whence |
offset | - the seeking offset |
path | - the file stream path |
- Returns
- A newly initialized exception
- (instancetype) initWithStream: |
|
(NSString *) |
stream |
reason: |
|
(NSString *) |
reason |
code: |
|
(SCInteger) |
code |
eid: |
|
(NSString *) |
eid |
|
|
| |
Initializes an exception using the specified stream name, error description, error code and error ID.
- Attention
- Designed initializer
- Parameters
-
stream | - the name of the erroneous stream |
reason | - the error description |
code | - the code of the detected error |
eid | - the error ID |
- Returns
- A newly initialized exception
- (instancetype) initWithStreamName: |
|
(NSString *) |
stream |
|
Initializes a generic stream exception using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithUnexpected: |
|
(NSString *) |
unexpected |
expected: |
|
(NSString *) |
expected |
|
|
| |
Initializes an unexpected class exception SCL-20025 by using the specified unexpected class name and expected class name.
- Parameters
-
unexpected | - the unexpected class name |
expected | - the expected class name |
- Returns
- A newly initialized exception
- (instancetype) initWithUnexpected: |
|
(NSString *) |
unexpected |
expected: |
|
(NSString *) |
expected |
stream: |
|
(NSString *) |
stream |
|
|
| |
Initializes an unexpected class exception SCL-20025 by using the specified unexpected class name, expected class name and erroneous stream name.
- Parameters
-
unexpected | - the unexpected class name |
expected | - the expected class name |
stream | - the name of the erroneous class |
- Returns
- A newly initialized exception
- (instancetype) initWithUnknown: |
|
(NSString *) |
name |
|
Initializes an unknown class exception SCL-20024 by using the specified unknown class name.
- Parameters
-
name | - the name of the unknown class |
- Returns
- A newly initialized exception
Initializes an unknown class exception SCL-20024 by using the specified unknown class name and erroneous stream name.
- Parameters
-
name | - the unknown class name |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithUnsupported: |
|
(NSString *) |
name |
|
Initializes an unsupported class exception SCL-20026 by using the specified unsupported class name.
- Parameters
-
name | - the unsupported class name |
- Returns
- A newly initialized exception
Initializes an unsupported class exception SCL-20026 by using the specified unsupported class name and the erroneous stream name.
- Parameters
-
name | - the unsupported class name |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithUnsupportedNumberType: |
|
(NSString *) |
type |
|
Initializes a number object exception SCL-20032 by using the specified type of the unsupported number object.
- Parameters
-
type | - the unsupported number object type |
- Returns
- A newly initialized exception
Initializes a number object exception SCL-20032 by using the specified unsupported number object type and erroneous stream name.
- Parameters
-
type | - the type of the unsupported number object |
stream | - the name of the erroneous name |
- Returns
- A newly initialized exception
Initializes an incorrect offset whence exception SCL-20037 by using the specified incorrect offset whence.
- Parameters
-
whence | - the incorrect offset whence |
- Returns
- A newly initialized exception
Initializes an incorrect offset whence exception SCL-20037 by using the specified incorrect offset whence and file stream path.
- Parameters
-
whence | - the incorrect offset whence |
path | - the path to the file stream |
- Returns
- A newly initialized exception
- (instancetype) initWithWrited: |
|
(SCSize) |
writed |
waited: |
|
(SCSize) |
waited |
|
|
| |
Initializes an incomplited writing operation SCL-20028 by using the specified number of actually writed bytes and number of waited bytes.
- Parameters
-
writed | - the number of the actually writed bytes |
waited | - the number of the waited bytes |
- Returns
- A newly initialized exception
- (instancetype) initWithWrited: |
|
(SCSize) |
writed |
waited: |
|
(SCSize) |
waited |
stream: |
|
(NSString *) |
stream |
|
|
| |
Initializes an incomplited writing operation SCL-20028 by using the specified number of actually writed bytes, number of waited bytes and erroneous stream name.
- Parameters
-
writed | - the number of the actually writed bytes |
waited | - the number of the waited bytes |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithWriteError: |
|
(SCInteger) |
error |
|
Initializes a writing exception SCL-20031 by using the specified writing error code.
- Parameters
-
error | - the writing error code |
- Returns
- A newly initialized
Initializes a writing exception SCL-20031 by using the specified writing error code and erroneous stream name.
- Parameters
-
error | - the writing error code |
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
- (instancetype) initWithWriteOnly |
|
|
|
Initializes a write only stream exception SCL-20023 by using the default settings.
- Returns
- A newly initialized exception
- (instancetype) initWithWriteOnlyStream: |
|
(NSString *) |
stream |
|
Initializes a write only stream exception SCL-20023 by using the specified erroneous stream name.
- Parameters
-
stream | - the name of the erroneous stream |
- Returns
- A newly initialized exception
Name of the expected class
Unsupported number object type
Incorrect file stream offset
Code of the stream opening error
Incorrect stream open mode
Number of actually readed bytes from the stream
Code of the stream reading error
Stream seeking error code
Name of the unexpected class
Name of the detected unknown class
- (NSString*) unsupported |
|
readnonatomicretain |
Name of the detected unsupported by streams class
Number of waited during reading or writing operation bytes
Incorrect file stream offset whence
Number of actually writed bytes to the stream
Code of the stream writing error
The documentation for this class was generated from the following files: