GI.Gio.Objects.DataOutputStream

Data output stream implements OutputStream and includes functions for writing data directly to an output stream.

Exported types

newtype DataOutputStream

Memory-managed wrapper type.

Constructors

DataOutputStream (ManagedPtr DataOutputStream)

Instances

Eq DataOutputStream

Defined in GI.Gio.Objects.DataOutputStream

Methods

(==) :: DataOutputStream -> DataOutputStream -> Bool

(/=) :: DataOutputStream -> DataOutputStream -> Bool

GObject DataOutputStream

Defined in GI.Gio.Objects.DataOutputStream

Methods

gobjectType :: IO GType

IsGValue DataOutputStream

Convert DataOutputStream to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.DataOutputStream

Methods

toGValue :: DataOutputStream -> IO GValue

fromGValue :: GValue -> IO DataOutputStream

HasParentTypes DataOutputStream

Defined in GI.Gio.Objects.DataOutputStream

type ParentTypes DataOutputStream

Defined in GI.Gio.Objects.DataOutputStream

type ParentTypes DataOutputStream = '[FilterOutputStream, OutputStream, Object, Seekable]

class (GObject o, IsDescendantOf DataOutputStream o) => IsDataOutputStream o

Type class for types which can be safely cast to DataOutputStream, for instance with toDataOutputStream.

Instances

(GObject o, IsDescendantOf DataOutputStream o) => IsDataOutputStream o

Defined in GI.Gio.Objects.DataOutputStream

toDataOutputStream :: (MonadIO m, IsDataOutputStream o) => o -> m DataOutputStream

Cast to DataOutputStream, for types for which this is known to be safe. For general casts, use castTo.

noDataOutputStream :: Maybe DataOutputStream

A convenience alias for Nothing :: Maybe DataOutputStream.

Methods

Overloaded methods

getByteOrder

dataOutputStreamGetByteOrder

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a)

=> a

stream: a DataOutputStream.

-> m DataStreamByteOrder

Returns: the DataStreamByteOrder for the stream.

Gets the byte order for the stream.

new

dataOutputStreamNew

Arguments

:: (HasCallStack, MonadIO m, IsOutputStream a)

=> a

baseStream: a OutputStream.

-> m DataOutputStream

Returns: DataOutputStream.

Creates a new data output stream for baseStream.

putByte

dataOutputStreamPutByte

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Word8

data: a guchar.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts a byte into the output stream.

putInt16

dataOutputStreamPutInt16

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Int16

data: a gint16.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts a signed 16-bit integer into the output stream.

putInt32

dataOutputStreamPutInt32

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Int32

data: a gint32.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts a signed 32-bit integer into the output stream.

putInt64

dataOutputStreamPutInt64

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Int64

data: a gint64.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts a signed 64-bit integer into the stream.

putString

dataOutputStreamPutString

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Text

str: a string.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts a string into the output stream.

putUint16

dataOutputStreamPutUint16

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Word16

data: a guint16.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts an unsigned 16-bit integer into the output stream.

putUint32

dataOutputStreamPutUint32

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Word32

data: a guint32.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts an unsigned 32-bit integer into the stream.

putUint64

dataOutputStreamPutUint64

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a, IsCancellable b)

=> a

stream: a DataOutputStream.

-> Word64

data: a guint64.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m ()

(Can throw GError)

Puts an unsigned 64-bit integer into the stream.

setByteOrder

dataOutputStreamSetByteOrder

Arguments

:: (HasCallStack, MonadIO m, IsDataOutputStream a)

=> a

stream: a DataOutputStream.

-> DataStreamByteOrder

order: a GDataStreamByteOrder.

-> m ()

Sets the byte order of the data output stream to order.

Properties

byteOrder

Determines the byte ordering that is used when writing multi-byte entities (such as integers) to the stream.

constructDataOutputStreamByteOrder :: IsDataOutputStream o => DataStreamByteOrder -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “byte-order” property. This is rarely needed directly, but it is used by new.

getDataOutputStreamByteOrder :: (MonadIO m, IsDataOutputStream o) => o -> m DataStreamByteOrder

Get the value of the “byte-order” property. When overloading is enabled, this is equivalent to

get dataOutputStream #byteOrder

setDataOutputStreamByteOrder :: (MonadIO m, IsDataOutputStream o) => o -> DataStreamByteOrder -> m ()

Set the value of the “byte-order” property. When overloading is enabled, this is equivalent to

set dataOutputStream [ #byteOrder := value ]