IsoStream_Iface Struct Reference

Interface definition for IsoStream methods. More...

#include <libisofs.h>


Data Fields

int version
char type [4]
 Type of Stream.
int(* open )(IsoStream *stream)
 Opens the stream.
int(* close )(IsoStream *stream)
 Close the Stream.
off_t(* get_size )(IsoStream *stream)
 Get the size (in bytes) of the stream.
int(* read )(IsoStream *stream, void *buf, size_t count)
 Attempts to read up to count bytes from the given stream into the buffer starting at buf.
int(* is_repeatable )(IsoStream *stream)
 Whether this IsoStream can be read several times, with the same results.
void(* get_id )(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id, ino_t *ino_id)
 Get an unique identifier for the IsoStream.
void(* free )(IsoStream *stream)
 Free implementation specific data.
int(* update_size )(IsoStream *stream)
 Updates the size of the IsoStream with the current size of the underlying source.


Detailed Description

Interface definition for IsoStream methods.

Since:
0.6.4

Definition at line 766 of file libisofs.h.


Field Documentation

Close the Stream.

Returns:
1 on success, < 0 on error (has to be a valid libisofs error code)

void(* IsoStream_Iface::free)(IsoStream *stream)

Free implementation specific data.

Should never be called by user. Use iso_stream_unref() instead.

void(* IsoStream_Iface::get_id)(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id, ino_t *ino_id)

Get an unique identifier for the IsoStream.

Get the size (in bytes) of the stream.

This function should always return the same size, even if the underlying source size changes, unless you call update_size() method.

Whether this IsoStream can be read several times, with the same results.

For example, a regular file is repeatable, you can read it as many times as you want. However, a pipe isn't.

This function doesn't take into account if the file has been modified between the two reads.

Returns:
1 if stream is repeatable, 0 if not, < 0 on error (has to be a valid libisofs error code)

Opens the stream.

Returns:
1 on success, 2 file greater than expected, 3 file smaller than expected, < 0 on error (has to be a valid libisofs error code)

int(* IsoStream_Iface::read)(IsoStream *stream, void *buf, size_t count)

Attempts to read up to count bytes from the given stream into the buffer starting at buf.

The stream must be open() before calling this, and close() when no more needed.

Returns:
number of bytes read, 0 if EOF, < 0 on error (has to be a valid libisofs error code)

Type of Stream.

"fsrc" -> Read from file source "mem " -> Read from memory "boot" -> Boot catalog "user" -> User supplied stream

Definition at line 783 of file libisofs.h.

Updates the size of the IsoStream with the current size of the underlying source.

After calling this, get_size() will return the new size. This should never be called after iso_image_create_burn_source() was called and the image was not completely written. To update the size of all files before written the image, you may want to call iso_image_update_sizes() just before iso_image_create_burn_source().

Returns:
1 if ok, < 0 on error (has to be a valid libisofs error code)
Since:
0.6.8

Definition at line 774 of file libisofs.h.


The documentation for this struct was generated from the following file:

Generated for libisofs by  doxygen 1.5.8