GMime.StreamFile

Subclasses:

None

Methods

Inherited:

GMime.Stream (17), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (fp)
class	new_with_bounds (fp, start, end)
class	open (path, mode)
	get_owner ()
	set_owner (owner)

Virtual Methods

Inherited:

GMime.Stream (10), GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
fp	object	r	standard-c FILE pointer
owner	bool	r	True if this stream owns fd
parent_object	GMime.Stream	r	parent GMime.Stream

Class Details

class GMime.StreamFile(**kwargs)

Bases:

GMime.Stream

Abstract:

No

Structure:

GMime.StreamFileClass

A GMime.Stream wrapper around standard-c FILE pointers.

classmethod new(fp)

Parameters:

fp (object or None) – a FILE pointer

Returns:

a stream using fp.

Return type:

GMime.Stream

Creates a new GMime.StreamFile object around fp.

Note: The created GMime.StreamFile object will own the FILE pointer passed in.

classmethod new_with_bounds(fp, start, end)

Parameters:

• fp (object or None) – a FILE pointer

• start (int) – start boundary

• end (int) – end boundary

Returns:

a stream using fp with bounds start and end.

Return type:

GMime.Stream

Creates a new GMime.StreamFile object around fp with bounds start and end.

Note: The created GMime.StreamFile object will own the FILE pointer passed in.

classmethod open(path, mode)

Parameters:

• path (str) – the path to a file

• mode (str) – as in fopen(3)

Raises:

GLib.Error

Returns:

a stream using for reading and/or writing to the specified file path or None on error.

Return type:

GMime.Stream

Creates a new GMime.StreamFile object for the specified path.

get_owner()

Returns:

True if self owns the backend FILE pointer or False otherwise.

Return type:

bool

Gets whether or not self owns the backend FILE pointer.

set_owner(owner)

Parameters:

owner (bool) – True if this stream should own the FILE pointer or False otherwise

Sets whether or not self owns the backend FILE pointer.

Note: owner should be True if the stream should fclose() the backend FILE pointer when destroyed or False otherwise.