FMFileStream Class Reference

Inherits from NSObject
Declared in FM.h

Overview

A utility class for reading/writing from/to a .

– file

Gets the file.

- (FMFile *)file

Discussion

Gets the file.

Declared In

FM.h

+ fileStreamWithFile:

Initializes a new instance of the class.

+ (FMFileStream *)fileStreamWithFile:(FMFile *)file

Parameters

name="file">The

file.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– initWithFile:

Initializes a new instance of the class.

- (id)initWithFile:(FMFile *)file

Parameters

name="file">The

file.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– littleEndian

Gets whether to read/write using little-endian ordering.

- (bool)littleEndian

Discussion

Gets whether to read/write using little-endian ordering.

Declared In

FM.h

– read16

Converts a 16-bit network representation to an integer.

- (int)read16

Discussion

Converts a 16-bit network representation to an integer.

Declared In

FM.h

– read24

Converts a 24-bit network representation to an integer.

- (int)read24

Discussion

Converts a 24-bit network representation to an integer.

Declared In

FM.h

– read32

Converts a 32-bit network representation to an integer.

- (long long)read32

Discussion

Converts a 32-bit network representation to an integer.

Declared In

FM.h

– read40

Converts a 40-bit network representation to an integer.

- (long long)read40

Discussion

Converts a 40-bit network representation to an integer.

Declared In

FM.h

– read48

Converts a 48-bit network representation to an integer.

- (long long)read48

Discussion

Converts a 48-bit network representation to an integer.

Declared In

FM.h

– read56

Converts a 56-bit network representation to an integer.

- (long long)read56

Discussion

Converts a 56-bit network representation to an integer.

Declared In

FM.h

– read64

Converts a 64-bit network representation to an integer.

- (long long)read64

Discussion

Converts a 64-bit network representation to an integer.

Declared In

FM.h

– read8

Converts an 8-bit network representation to an integer.

- (int)read8

Discussion

Converts an 8-bit network representation to an integer.

Declared In

FM.h

– readOpaque16

Reads a 16-bit-length opaque value from a File.

- (NSMutableData *)readOpaque16

Discussion

Reads a 16-bit-length opaque value from a File.

Declared In

FM.h

– readOpaque24

Reads a 24-bit-length opaque value from a File.

- (NSMutableData *)readOpaque24

Discussion

Reads a 24-bit-length opaque value from a File.

Declared In

FM.h

– readOpaque32

Reads a 32-bit-length opaque value from a File.

- (NSMutableData *)readOpaque32

Discussion

Reads a 32-bit-length opaque value from a File.

Declared In

FM.h

– readOpaque8

Reads an 8-bit-length opaque value from a File.

- (NSMutableData *)readOpaque8

Discussion

Reads an 8-bit-length opaque value from a File.

Declared In

FM.h

– readWithLength:

Reads a value from a File.

- (NSMutableData *)readWithLength:(int)length

Parameters

name="length">The

number of bytes to read.

Discussion

Reads a value from a File.

Declared In

FM.h

– setLittleEndian:

Sets whether to read/write using little-endian ordering.

- (void)setLittleEndian:(bool)value

Discussion

Sets whether to read/write using little-endian ordering.

Declared In

FM.h

– write16ToWithLocation:value:

Adds a 16-bit value to a File.

- (void)write16ToWithLocation:(int)location value:(int)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 16-bit value to a File.

Declared In

FM.h

– write16WithValue:

Adds a 16-bit value to a File.

- (void)write16WithValue:(int)value

Parameters

name="value">The

value.

Discussion

Adds a 16-bit value to a File.

Declared In

FM.h

– write24ToWithLocation:value:

Adds a 24-bit value to a File.

- (void)write24ToWithLocation:(int)location value:(int)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 24-bit value to a File.

Declared In

FM.h

– write24WithValue:

Adds a 24-bit value to a File.

- (void)write24WithValue:(int)value

Parameters

name="value">The

value.

Discussion

Adds a 24-bit value to a File.

Declared In

FM.h

– write32ToWithLocation:value:

Adds a 32-bit value to a File.

- (void)write32ToWithLocation:(int)location value:(long long)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 32-bit value to a File.

Declared In

FM.h

– write32WithValue:

Adds a 32-bit value to a File.

- (void)write32WithValue:(long long)value

Parameters

name="value">The

value.

Discussion

Adds a 32-bit value to a File.

Declared In

FM.h

– write40ToWithLocation:value:

Adds a 40-bit value to a File.

- (void)write40ToWithLocation:(int)location value:(long long)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 40-bit value to a File.

Declared In

FM.h

– write40WithValue:

Adds a 40-bit value to a File.

- (void)write40WithValue:(long long)value

Parameters

name="value">The

value.

Discussion

Adds a 40-bit value to a File.

Declared In

FM.h

– write48ToWithLocation:value:

Adds a 48-bit value to a File.

- (void)write48ToWithLocation:(int)location value:(long long)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 48-bit value to a File.

Declared In

FM.h

– write48WithValue:

Adds a 48-bit value to a File.

- (void)write48WithValue:(long long)value

Parameters

name="value">The

value.

Discussion

Adds a 48-bit value to a File.

Declared In

FM.h

– write56ToWithLocation:value:

Adds a 56-bit value to a File.

- (void)write56ToWithLocation:(int)location value:(long long)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 56-bit value to a File.

Declared In

FM.h

– write56WithValue:

Adds a 56-bit value to a File.

- (void)write56WithValue:(long long)value

Parameters

name="value">The

value.

Discussion

Adds a 56-bit value to a File.

Declared In

FM.h

– write64ToWithLocation:value:

Adds a 64-bit value to a File.

- (void)write64ToWithLocation:(int)location value:(long long)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 64-bit value to a File.

Declared In

FM.h

– write64WithValue:

Adds a 64-bit value to a File.

- (void)write64WithValue:(long long)value

Parameters

name="value">The

value.

Discussion

Adds a 64-bit value to a File.

Declared In

FM.h

– write8ToWithLocation:value:

Adds an 8-bit value to a File.

- (void)write8ToWithLocation:(int)location value:(int)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds an 8-bit value to a File.

Declared In

FM.h

– write8WithValue:

Adds an 8-bit value to a File.

- (void)write8WithValue:(int)value

Parameters

name="value">The

value.

Discussion

Adds an 8-bit value to a File.

Declared In

FM.h

– writeOpaque16ToWithLocation:value:

Adds a 16-bit-length opaque value to a File.

- (void)writeOpaque16ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 16-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque16WithValue:

Adds a 16-bit-length opaque value to a File.

- (void)writeOpaque16WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 16-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque24ToWithLocation:value:

Adds a 24-bit-length opaque value to a File.

- (void)writeOpaque24ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 24-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque24WithValue:

Adds a 24-bit-length opaque value to a File.

- (void)writeOpaque24WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 24-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque32ToWithLocation:value:

Adds a 32-bit-length opaque value to a File.

- (void)writeOpaque32ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 32-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque32WithValue:

Adds a 32-bit-length opaque value to a File.

- (void)writeOpaque32WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 32-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque40ToWithLocation:value:

Adds a 40-bit-length opaque value to a File.

- (void)writeOpaque40ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 40-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque40WithValue:

Adds a 40-bit-length opaque value to a File.

- (void)writeOpaque40WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 40-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque48ToWithLocation:value:

Adds a 48-bit-length opaque value to a File.

- (void)writeOpaque48ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 48-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque48WithValue:

Adds a 48-bit-length opaque value to a File.

- (void)writeOpaque48WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 48-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque56ToWithLocation:value:

Adds a 56-bit-length opaque value to a File.

- (void)writeOpaque56ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 56-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque56WithValue:

Adds a 56-bit-length opaque value to a File.

- (void)writeOpaque56WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 56-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque64ToWithLocation:value:

Adds a 64-bit-length opaque value to a File.

- (void)writeOpaque64ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a 64-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque64WithValue:

Adds a 64-bit-length opaque value to a File.

- (void)writeOpaque64WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a 64-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque8ToWithLocation:value:

Adds an 8-bit-length opaque value to a File.

- (void)writeOpaque8ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds an 8-bit-length opaque value to a File.

Declared In

FM.h

– writeOpaque8WithValue:

Adds an 8-bit-length opaque value to a File.

- (void)writeOpaque8WithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds an 8-bit-length opaque value to a File.

Declared In

FM.h

– writeToWithLocation:value:

Adds a value to a File.

- (void)writeToWithLocation:(int)location value:(NSMutableData *)value

Parameters

name="location">The

location to write to.
name="value">The

value.

Discussion

Adds a value to a File.

Declared In

FM.h

– writeWithValue:

Adds a value to a File.

- (void)writeWithValue:(NSMutableData *)value

Parameters

name="value">The

value.

Discussion

Adds a value to a File.

Declared In

FM.h