Camel.StreamFilter

Subclasses:

None

Methods

Inherited:

Camel.Stream (10), GObject.Object (37), Gio.Seekable (5)

Structs:

GObject.ObjectClass (5)

class	new (source)
	add (filter)
	get_source ()
	remove (id)

Virtual Methods

Inherited:

Camel.Stream (5), GObject.Object (7), Gio.Seekable (5)

Properties

Inherited:

Camel.Stream (1)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	Camel.Stream	r

Class Details

class Camel.StreamFilter(**kwargs)

Bases:

Camel.Stream

Abstract:

No

Structure:

Camel.StreamFilterClass

classmethod new(source)

Parameters:

source (Camel.Stream) – a Camel.Stream to filter

Returns:

a new Camel.StreamFilter object.

Return type:

Camel.Stream

Create a new Camel.StreamFilter object. The source stream is referenced, thus the caller can unref it, if not needed.

New in version 2.32.

add(filter)

Parameters:

filter (Camel.MimeFilter) – a Camel.MimeFilter object

Returns:

a filter id for the added filter.

Return type:

int

Add a new Camel.MimeFilter to execute during the processing of this stream. Each filter added is processed after the previous one.

Note that a filter should only be added to a single stream at a time, otherwise unpredictable results may occur.

get_source()

Return type:

Camel.Stream

New in version 2.32.

remove(id)

Parameters:

id (int) – Filter id, as returned from Camel.StreamFilter.add()

Remove a processing filter from the stream by id.