SFBInputSource


@interface SFBInputSource : NSObject

An input source


                    
                    
                    +inputSourceForURL:flags:error:

Returns an initialized \c SFBInputSource object for the given URL or \c nil on failure

Declaration

Objective-C

+ (nullable instancetype)inputSourceForURL:(nonnull NSURL *)url
                                     flags:(SFBInputSourceFlags)flags
                                     error:(NSError *_Nullable *_Nullable)error;

Parameters

`url`	The URL
`flags`	Optional flags affecting how \c url is handled
`error`	An optional pointer to a \c NSError to receive error information

Return Value

An initialized \c SFBInputSource object for the specified URL, or \c nil on failure


                    
                    
                    +inputSourceWithData:

Returns an initialized \c SFBInputSource for the given \c NSData object

Declaration

Objective-C

+ (nonnull instancetype)inputSourceWithData:(nonnull NSData *)data;

Parameters


                                data

The desired data

Return Value

An initialized \c SFBInputSource object


                    
                    
                    +inputSourceWithBytes:length:

Returns an initialized \c SFBInputSource for the given byte buffer or \c nil on failure

Declaration

Objective-C

+ (nullable instancetype)inputSourceWithBytes:(nonnull const void *)bytes
                                       length:(NSInteger)length;

Parameters

`bytes`	A pointer to the desired byte buffer
`length`	The number of bytes in \c bytes

Return Value

An initialized \c SFBInputSource object or \c nil on faliure


                    
                    
                    +inputSourceWithBytesNoCopy:length:freeWhenDone:

Returns an initialized \c SFBInputSource for the given byte buffer or \c nil on failure

Note

If \c freeWhenDone is \c YES, \c bytes must point to a buffer allocated with \c malloc

Declaration

Objective-C

+ (nullable instancetype)inputSourceWithBytesNoCopy:(nonnull void *)bytes
                                             length:(NSInteger)length
                                       freeWhenDone:(BOOL)freeWhenDone;

Parameters

`bytes`	A pointer to the desired byte buffer
`length`	The number of bytes in \c bytes
`freeWhenDone`	If \c YES the returned object takes ownership of \c bytes and frees it on deallocation

Return Value

An initialized \c SFBInputSource object or \c nil on faliure

url
Returns the URL corresponding to this input source or \c nil if none
Declaration
Objective-C

@property (nonatomic, readonly, nullable) NSURL *url;


                    
                    
                    -openReturningError:

Opens the input source for reading

Declaration

Objective-C

- (BOOL)openReturningError:(NSError *_Nullable *_Nullable)error;

Parameters


                                error

An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -closeReturningError:

Closes the input source

Declaration

Objective-C

- (BOOL)closeReturningError:(NSError *_Nullable *_Nullable)error;

Parameters


                                error

An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise

isOpen
Returns \c YES if the input source is open
Declaration
Objective-C

@property (nonatomic, readonly) BOOL isOpen;


                    
                    
                    -readBytes:length:bytesRead:error:

Reads bytes from the input

Declaration

Objective-C

- (BOOL)readBytes:(nonnull void *)buffer
           length:(NSInteger)length
        bytesRead:(nonnull NSInteger *)bytesRead
            error:(NSError *_Nullable *_Nullable)error;

Parameters

`buffer`	A buffer to receive data
`length`	The maximum number of bytes to read
`bytesRead`	The number of bytes actually read
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES if any bytes were read, \c NO otherwise

atEOF
Returns \c YES if the end of input has been reached
Declaration
Objective-C

@property (nonatomic, readonly) BOOL atEOF;


                    
                    
                    -getOffset:error:

Returns the current offset in the input, in bytes

Declaration

Objective-C

- (BOOL)getOffset:(nonnull NSInteger *)offset
            error:(NSError *_Nullable *_Nullable)error;


                    
                    
                    -getLength:error:

Returns the length of the input, in bytes

Declaration

Objective-C

- (BOOL)getLength:(nonnull NSInteger *)length
            error:(NSError *_Nullable *_Nullable)error;

supportsSeeking
Returns \c YES if the input is seekable
Declaration
Objective-C

@property (nonatomic, readonly) BOOL supportsSeeking;


                    
                    
                    -seekToOffset:error:

Seeks to the specified byte offset

Declaration

Objective-C

- (BOOL)seekToOffset:(NSInteger)offset
               error:(NSError *_Nullable *_Nullable)error;

Parameters


                                offset

The desired offset, in bytes

Return Value

\c YES on success, \c NO otherwise

SFBSignedIntegerReading


                    
                    
                    -readInt8:error:

Reads an 8-bit signed integer from the input

Declaration

Objective-C

- (BOOL)readInt8:(nonnull int8_t *)i8
           error:(NSError *_Nullable *_Nullable)error;

Parameters

`i8`	A pointer to an \c int8_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readInt16:error:

Reads a 16-bit signed integer from the input

Declaration

Objective-C

- (BOOL)readInt16:(nonnull int16_t *)i16
            error:(NSError *_Nullable *_Nullable)error;

Parameters

`i16`	A pointer to an \c int16_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readInt32:error:

Reads an 32-bit signed integer from the input

Declaration

Objective-C

- (BOOL)readInt32:(nonnull int32_t *)i32
            error:(NSError *_Nullable *_Nullable)error;

Parameters

`i32`	A pointer to an \c int32_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readInt64:error:

Reads an 64-bit signed integer from the input

Declaration

Objective-C

- (BOOL)readInt64:(nonnull int64_t *)i64
            error:(NSError *_Nullable *_Nullable)error;

Parameters

`i64`	A pointer to an \c int64_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise

SFBUnsignedIntegerReading


                    
                    
                    -readUInt8:error:

Reads an 8-bit unsigned integer from the input

Declaration

Objective-C

- (BOOL)readUInt8:(nonnull uint8_t *)ui8
            error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui8`	A pointer to an \c uint8_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt16:error:

Reads a 16-bit unsigned integer from the input

Declaration

Objective-C

- (BOOL)readUInt16:(nonnull uint16_t *)ui16
             error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui16`	A pointer to an \c uint16_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt32:error:

Reads an 32-bit unsigned integer from the input

Declaration

Objective-C

- (BOOL)readUInt32:(nonnull uint32_t *)ui32
             error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui32`	A pointer to an \c uint32_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt64:error:

Reads an 64-bit unsigned integer from the input

Declaration

Objective-C

- (BOOL)readUInt64:(nonnull uint64_t *)ui64
             error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui64`	A pointer to an \c uint64_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise

SFBBigEndianReading


                    
                    
                    -readUInt16BigEndian:error:

Reads a 16-bit unsigned integer from the input in big-endian format

Declaration

Objective-C

- (BOOL)readUInt16BigEndian:(nonnull uint16_t *)ui16
                      error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui16`	A pointer to an \c uint16_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt32BigEndian:error:

Reads an 32-bit unsigned integer from the input in big-endian format

Declaration

Objective-C

- (BOOL)readUInt32BigEndian:(nonnull uint32_t *)ui32
                      error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui32`	A pointer to an \c uint32_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt64BigEndian:error:

Reads an 64-bit unsigned integer from the input in big-endian format

Declaration

Objective-C

- (BOOL)readUInt64BigEndian:(nonnull uint64_t *)ui64
                      error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui64`	A pointer to an \c uint64_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise

SFBLittleEndianReading


                    
                    
                    -readUInt16LittleEndian:error:

Reads a 16-bit unsigned integer from the input in little-endian format

Declaration

Objective-C

- (BOOL)readUInt16LittleEndian:(nonnull uint16_t *)ui16
                         error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui16`	A pointer to an \c uint16_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt32LittleEndian:error:

Reads an 32-bit unsigned integer from the input in little-endian format

Declaration

Objective-C

- (BOOL)readUInt32LittleEndian:(nonnull uint32_t *)ui32
                         error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui32`	A pointer to an \c uint32_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    -readUInt64LittleEndian:error:

Reads an 64-bit unsigned integer from the input in little-endian format

Declaration

Objective-C

- (BOOL)readUInt64LittleEndian:(nonnull uint64_t *)ui64
                         error:(NSError *_Nullable *_Nullable)error;

Parameters

`ui64`	A pointer to an \c uint64_t to receive the value
`error`	An optional pointer to an \c NSError object to receive error information

Return Value

\c YES on success, \c NO otherwise


                    
                    
                    read(_:length:)

Reads bytes from the input

Throws

An NSError object if an error occurs

Declaration

Swift

public func read(_ buffer: UnsafeMutableRawPointer, length: Int) throws -> Int

Parameters

`buffer`	A buffer to receive data
`length`	The maximum number of bytes to read

Return Value

The number of bytes actually read

offset()
Returns the current offset in the input, in bytes

Throws
An NSError object if an error occurs
Declaration
Swift

public func offset() throws -> Int
length()
Returns the length of the input, in bytes

Throws
An NSError object if an error occurs
Declaration
Swift

public func length() throws -> Int
read()
Reads and returns a binary integer

Throws
An NSError object if an error occurs
Declaration
Swift

public func read<T>() throws -> T where T : BinaryInteger
Return Value

The integer value read
readBigEndian()
Reads a 16-bit integer from the input in big-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readBigEndian() throws -> UInt16
readBigEndian()
Reads a 32-bit integer from the input in big-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readBigEndian() throws -> UInt32
readBigEndian()
Reads a 64-bit integer from the input in big-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readBigEndian() throws -> UInt64
readLittleEndian()
Reads a 16-bit integer from the input in little-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readLittleEndian() throws -> UInt16
readLittleEndian()
Reads a 32-bit integer from the input in little-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readLittleEndian() throws -> UInt32
readLittleEndian()
Reads a 64-bit integer from the input in little-endian format and returns the value

Throws
An NSError object if an error occurs
Declaration
Swift

public func readLittleEndian() throws -> UInt64