Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GLib.Structs.IConv

Contents

Exported types
Methods
- close

Description

The GIConv struct wraps an iconv() conversion descriptor. It contains private data and should only be accessed using the following functions.

Synopsis

Exported types

newtype IConv Source #

Memory-managed wrapper type.

Constructors

IConv (ManagedPtr IConv)

Instances

WrappedPtr IConv Source #
Methods wrappedPtrCalloc :: IO (Ptr IConv) # wrappedPtrCopy :: IConv -> IO IConv # wrappedPtrFree :: Maybe (FunPtr (Ptr IConv -> IO ())) #

noIConv :: Maybe IConv Source #

A convenience alias for Nothing :: Maybe IConv.

Methods

close

iConvClose Source #

Arguments

:: (HasCallStack, MonadIO m)
=> IConv	`converter`: a conversion descriptor from `g_iconv_open()`
-> m Int32	Returns: -1 on error, 0 on success

Same as the standard UNIX routine iconv_close(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. Should be called to clean up the conversion descriptor from g_iconv_open() when you are done converting things.

GLib provides convert and localeToUtf8 which are likely more convenient than the raw iconv wrappers.