gi-glib-2.0.12: GLib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.String

Contents

Description

The GString struct contains the public fields of a GString.

Synopsis

Exported types

newtype String #

Constructors

String (ManagedPtr String) 

Instances

BoxedObject String # 

Methods

boxedType :: String -> IO GType #

(~) AttrOpTag tag AttrSet => Constructible String tag # 

Methods

new :: MonadIO m => (ManagedPtr String -> String) -> [AttrOp String tag] -> m String #

((~) * info (ResolveStringMethod t String), MethodInfo * info String p) => IsLabel t (String -> p) # 

Methods

fromLabel :: Proxy# Symbol t -> String -> p #

((~) * info (ResolveStringMethod t String), MethodInfo * info String p) => IsLabelProxy t (String -> p) # 

Methods

fromLabelProxy :: Proxy Symbol t -> String -> p #

HasAttributeList * String # 
((~) * signature (m String), MonadIO m) => MethodInfo * StringUpMethodInfo String signature # 
((~) * signature (Word64 -> m String), MonadIO m) => MethodInfo * StringTruncateMethodInfo String signature # 
((~) * signature (Word64 -> m String), MonadIO m) => MethodInfo * StringSetSizeMethodInfo String signature # 
((~) * signature (Char -> m String), MonadIO m) => MethodInfo * StringPrependUnicharMethodInfo String signature # 
((~) * signature (Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringPrependLenMethodInfo String signature # 
((~) * signature (Int8 -> m String), MonadIO m) => MethodInfo * StringPrependCMethodInfo String signature # 
((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringPrependMethodInfo String signature # 
((~) * signature (Word64 -> Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringOverwriteLenMethodInfo String signature # 
((~) * signature (Word64 -> Text -> m String), MonadIO m) => MethodInfo * StringOverwriteMethodInfo String signature # 
((~) * signature (Int64 -> Char -> m String), MonadIO m) => MethodInfo * StringInsertUnicharMethodInfo String signature # 
((~) * signature (Int64 -> Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringInsertLenMethodInfo String signature # 
((~) * signature (Int64 -> Int8 -> m String), MonadIO m) => MethodInfo * StringInsertCMethodInfo String signature # 
((~) * signature (Int64 -> Text -> m String), MonadIO m) => MethodInfo * StringInsertMethodInfo String signature # 
((~) * signature (m Word32), MonadIO m) => MethodInfo * StringHashMethodInfo String signature # 
((~) * signature (m Bytes), MonadIO m) => MethodInfo * StringFreeToBytesMethodInfo String signature # 
((~) * signature (Bool -> m (Maybe Text)), MonadIO m) => MethodInfo * StringFreeMethodInfo String signature # 
((~) * signature (Int64 -> Int64 -> m String), MonadIO m) => MethodInfo * StringEraseMethodInfo String signature # 
((~) * signature (String -> m Bool), MonadIO m) => MethodInfo * StringEqualMethodInfo String signature # 
((~) * signature (m String), MonadIO m) => MethodInfo * StringDownMethodInfo String signature # 
((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringAssignMethodInfo String signature # 
((~) * signature (m String), MonadIO m) => MethodInfo * StringAsciiUpMethodInfo String signature # 
((~) * signature (m String), MonadIO m) => MethodInfo * StringAsciiDownMethodInfo String signature # 
((~) * signature (Text -> Text -> Bool -> m String), MonadIO m) => MethodInfo * StringAppendUriEscapedMethodInfo String signature # 
((~) * signature (Char -> m String), MonadIO m) => MethodInfo * StringAppendUnicharMethodInfo String signature # 
((~) * signature (Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringAppendLenMethodInfo String signature # 
((~) * signature (Int8 -> m String), MonadIO m) => MethodInfo * StringAppendCMethodInfo String signature # 
((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringAppendMethodInfo String signature # 
type AttributeList String # 

newZeroString :: MonadIO m => m String #

Construct a String struct initialized to zero.

Methods

append

data StringAppendMethodInfo #

Instances

((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringAppendMethodInfo String signature # 

stringAppend #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Text

val: the string to append onto the end of string

-> m String

Returns: string

Adds a string onto the end of a String, expanding it if necessary.

appendC

data StringAppendCMethodInfo #

Instances

((~) * signature (Int8 -> m String), MonadIO m) => MethodInfo * StringAppendCMethodInfo String signature # 

stringAppendC #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int8

c: the byte to append onto the end of string

-> m String

Returns: string

Adds a byte onto the end of a String, expanding it if necessary.

appendLen

data StringAppendLenMethodInfo #

Instances

((~) * signature (Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringAppendLenMethodInfo String signature # 

stringAppendLen #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Text

val: bytes to append

-> Int64

len: number of bytes of val to use

-> m String

Returns: string

Appends len bytes of val to string. Because len is provided, val may contain embedded nuls and need not be nul-terminated.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that val has at least len addressable bytes.

appendUnichar

stringAppendUnichar #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Char

wc: a Unicode character

-> m String

Returns: string

Converts a Unicode character into UTF-8, and appends it to the string.

appendUriEscaped

stringAppendUriEscaped #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Text

unescaped: a string

-> Text

reservedCharsAllowed: a string of reserved characters allowed to be used, or Nothing

-> Bool

allowUtf8: set True if the escaped string may include UTF8 characters

-> m String

Returns: string

Appends unescaped to string, escaped any characters that are reserved in URIs using URI-style escape sequences.

Since: 2.16

asciiDown

stringAsciiDown #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a GString

-> m String

Returns: passed-in string pointer, with all the uppercase characters converted to lowercase in place, with semantics that exactly match asciiTolower.

Converts all uppercase ASCII letters to lowercase ASCII letters.

asciiUp

data StringAsciiUpMethodInfo #

Instances

((~) * signature (m String), MonadIO m) => MethodInfo * StringAsciiUpMethodInfo String signature # 

stringAsciiUp #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a GString

-> m String

Returns: passed-in string pointer, with all the lowercase characters converted to uppercase in place, with semantics that exactly match asciiToupper.

Converts all lowercase ASCII letters to uppercase ASCII letters.

assign

data StringAssignMethodInfo #

Instances

((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringAssignMethodInfo String signature # 

stringAssign #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: the destination String. Its current contents are destroyed.

-> Text

rval: the string to copy into string

-> m String

Returns: string

Copies the bytes from a string into a String, destroying any previous contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string.

down

data StringDownMethodInfo #

Instances

((~) * signature (m String), MonadIO m) => MethodInfo * StringDownMethodInfo String signature # 

stringDown #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> m String

Returns: the String

Deprecated: (Since version 2.2)This function uses the locale-specific tolower() function, which is almost never the right thing. Use stringAsciiDown or utf8Strdown instead.

Converts a String to lowercase.

equal

data StringEqualMethodInfo #

Instances

((~) * signature (String -> m Bool), MonadIO m) => MethodInfo * StringEqualMethodInfo String signature # 

stringEqual #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

v: a String

-> String

v2: another String

-> m Bool

Returns: True if the strings are the same length and contain the same bytes

Compares two strings for equality, returning True if they are equal. For use with HashTable.

erase

data StringEraseMethodInfo #

Instances

((~) * signature (Int64 -> Int64 -> m String), MonadIO m) => MethodInfo * StringEraseMethodInfo String signature # 

stringErase #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int64

pos: the position of the content to remove

-> Int64

len: the number of bytes to remove, or -1 to remove all following bytes

-> m String

Returns: string

Removes len bytes from a String, starting at position pos. The rest of the String is shifted down to fill the gap.

free

data StringFreeMethodInfo #

Instances

((~) * signature (Bool -> m (Maybe Text)), MonadIO m) => MethodInfo * StringFreeMethodInfo String signature # 

stringFree #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Bool

freeSegment: if True, the actual character data is freed as well

-> m (Maybe Text)

Returns: the character data of string (i.e. Nothing if freeSegment is True)

Frees the memory allocated for the String. If freeSegment is True it also frees the character data. If it's False, the caller gains ownership of the buffer and must free it after use with free.

freeToBytes

stringFreeToBytes #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> m Bytes

Returns: A newly allocated Bytes containing contents of string; string itself is freed

Transfers ownership of the contents of string to a newly allocated Bytes. The String structure itself is deallocated, and it is therefore invalid to use string after invoking this function.

Note that while String ensures that its buffer always has a trailing nul character (not reflected in its "len"), the returned Bytes does not include this extra nul; i.e. it has length exactly equal to the "len" member.

Since: 2.34

hash

data StringHashMethodInfo #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * StringHashMethodInfo String signature # 

stringHash #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

str: a string to hash

-> m Word32

Returns: hash code for str

Creates a hash code for str; for use with HashTable.

insert

data StringInsertMethodInfo #

Instances

((~) * signature (Int64 -> Text -> m String), MonadIO m) => MethodInfo * StringInsertMethodInfo String signature # 

stringInsert #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int64

pos: the position to insert the copy of the string

-> Text

val: the string to insert

-> m String

Returns: string

Inserts a copy of a string into a String, expanding it if necessary.

insertC

data StringInsertCMethodInfo #

Instances

((~) * signature (Int64 -> Int8 -> m String), MonadIO m) => MethodInfo * StringInsertCMethodInfo String signature # 

stringInsertC #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int64

pos: the position to insert the byte

-> Int8

c: the byte to insert

-> m String

Returns: string

Inserts a byte into a String, expanding it if necessary.

insertLen

data StringInsertLenMethodInfo #

Instances

((~) * signature (Int64 -> Text -> Int64 -> m String), MonadIO m) => MethodInfo * StringInsertLenMethodInfo String signature # 

stringInsertLen #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int64

pos: position in string where insertion should happen, or -1 for at the end

-> Text

val: bytes to insert

-> Int64

len: number of bytes of val to insert

-> m String

Returns: string

Inserts len bytes of val into string at pos. Because len is provided, val may contain embedded nuls and need not be nul-terminated. If pos is -1, bytes are inserted at the end of the string.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that val has at least len addressable bytes.

insertUnichar

stringInsertUnichar #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int64

pos: the position at which to insert character, or -1 to append at the end of the string

-> Char

wc: a Unicode character

-> m String

Returns: string

Converts a Unicode character into UTF-8, and insert it into the string at the given position.

overwrite

stringOverwrite #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Word64

pos: the position at which to start overwriting

-> Text

val: the string that will overwrite the string starting at pos

-> m String

Returns: string

Overwrites part of a string, lengthening it if necessary.

Since: 2.14

overwriteLen

stringOverwriteLen #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Word64

pos: the position at which to start overwriting

-> Text

val: the string that will overwrite the string starting at pos

-> Int64

len: the number of bytes to write from val

-> m String

Returns: string

Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls.

Since: 2.14

prepend

data StringPrependMethodInfo #

Instances

((~) * signature (Text -> m String), MonadIO m) => MethodInfo * StringPrependMethodInfo String signature # 

stringPrepend #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Text

val: the string to prepend on the start of string

-> m String

Returns: string

Adds a string on to the start of a String, expanding it if necessary.

prependC

data StringPrependCMethodInfo #

Instances

((~) * signature (Int8 -> m String), MonadIO m) => MethodInfo * StringPrependCMethodInfo String signature # 

stringPrependC #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Int8

c: the byte to prepend on the start of the String

-> m String

Returns: string

Adds a byte onto the start of a String, expanding it if necessary.

prependLen

stringPrependLen #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Text

val: bytes to prepend

-> Int64

len: number of bytes in val to prepend

-> m String

Returns: string

Prepends len bytes of val to string. Because len is provided, val may contain embedded nuls and need not be nul-terminated.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that val has at least len addressable bytes.

prependUnichar

stringPrependUnichar #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Char

wc: a Unicode character

-> m String

Returns: string

Converts a Unicode character into UTF-8, and prepends it to the string.

setSize

data StringSetSizeMethodInfo #

Instances

((~) * signature (Word64 -> m String), MonadIO m) => MethodInfo * StringSetSizeMethodInfo String signature # 

stringSetSize #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Word64

len: the new length

-> m String

Returns: string

Sets the length of a String. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string->str[string->len] will be a nul byte.)

truncate

data StringTruncateMethodInfo #

Instances

((~) * signature (Word64 -> m String), MonadIO m) => MethodInfo * StringTruncateMethodInfo String signature # 

stringTruncate #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> Word64

len: the new size of string

-> m String

Returns: string

Cuts off the end of the GString, leaving the first len bytes.

up

data StringUpMethodInfo #

Instances

((~) * signature (m String), MonadIO m) => MethodInfo * StringUpMethodInfo String signature # 

stringUp #

Arguments

:: (HasCallStack, MonadIO m) 
=> String

string: a String

-> m String

Returns: string

Deprecated: (Since version 2.2)This function uses the locale-specific toupper() function, which is almost never the right thing. Use stringAsciiUp or utf8Strup instead.

Converts a String to uppercase.

Properties

allocatedLen

len

setStringLen :: MonadIO m => String -> Word64 -> m () #

str

clearStringStr :: MonadIO m => String -> m () #

setStringStr :: MonadIO m => String -> CString -> m () #