Skip to content

Gdk.ContentSerializer

class — extends GObject.Object, Gio.AsyncResult

Serializes content for inter-application data transfers.

The GdkContentSerializer transforms an object that is identified by a GType into a serialized form (i.e. a byte stream) that is identified by a mime type.

GTK provides serializers and deserializers for common data types such as text, colors, images or file lists. To register your own serialization functions, use content_register_serializer.

Also see ContentDeserializer.

Methods

get_cancellable

def get_cancellable(self) -> Gio.Cancellable | None

Gets the cancellable for the current operation.

This is the GCancellable that was passed to content_serialize_async.

get_gtype

def get_gtype(self) -> type | GObject.Type

Gets the GType to of the object to serialize.

get_mime_type

def get_mime_type(self) -> str

Gets the mime type to serialize to.

get_output_stream

def get_output_stream(self) -> Gio.OutputStream

Gets the output stream for the current operation.

This is the stream that was passed to content_serialize_async.

get_priority

def get_priority(self) -> int

Gets the I/O priority for the current operation.

This is the priority that was passed to content_serialize_async.

get_task_data

def get_task_data(self) -> int | None

Gets the data that was associated with the current operation.

See ContentSerializer.set_task_data.

get_user_data

def get_user_data(self) -> int | None

Gets the user data that was passed when the serializer was registered.

get_value

def get_value(self) -> GObject.Value

Gets the GValue to read the object to serialize from.

return_error

def return_error(self, error: GLib.Error) -> None

Indicate that the serialization has ended with an error.

This function consumes error.

Parameters:

  • error — a GError

return_success

def return_success(self) -> None

Indicate that the serialization has been successfully completed.

set_task_data

def set_task_data(self, data: int | None, notify: GLib.DestroyNotify) -> None

Associate data with the current serialization operation.

Parameters:

  • data — data to associate with this operation
  • notify — destroy notify for data