GI.NM.Structs.IPAddress

No description available in the introspection data.

Exported types

newtype IPAddress

Memory-managed wrapper type.

Constructors

IPAddress (ManagedPtr IPAddress)

Instances

Eq IPAddress

Defined in GI.NM.Structs.IPAddress

Methods

(==) :: IPAddress -> IPAddress -> Bool

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

GBoxed IPAddress

Defined in GI.NM.Structs.IPAddress

ManagedPtrNewtype IPAddress

Defined in GI.NM.Structs.IPAddress

Methods

toManagedPtr :: IPAddress -> ManagedPtr IPAddress

TypedObject IPAddress

Defined in GI.NM.Structs.IPAddress

Methods

glibType :: IO GType

HasParentTypes IPAddress

Defined in GI.NM.Structs.IPAddress

IsGValue (Maybe IPAddress)

Convert IPAddress to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Structs.IPAddress

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe IPAddress -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe IPAddress)

type ParentTypes IPAddress

Defined in GI.NM.Structs.IPAddress

type ParentTypes IPAddress = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

cmpFull, dup, equal, ref, unref.

Getters

getAddress, getAttribute, getAttributeNames, getFamily, getPrefix.

Setters

setAddress, setAttribute, setPrefix.

cmpFull

iPAddressCmpFull

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

a: the IPAddress

-> IPAddress

b: the IPAddress to compare address to.

-> [IPAddressCmpFlags]

cmpFlags: the IPAddressCmpFlags that indicate what to compare.

-> m Int32

Returns: 0 if the two objects have the same values (according to their flags) or a integer indicating the compare order.

Note that with cmpFlags NM_IP_ADDRESS_CMP_FLAGS_WITH_ATTRS, there is no total order for comparing GVariant. That means, if the two addresses only differ by their attributes, the sort order is undefined and the return value only indicates equality.

Since: 1.22

dup

iPAddressDup

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m IPAddress

Returns: a copy of address

This API was part of public headers before 1.32.0 but was erroneously not exported in the ABI. It is thus only usable since 1.32.0.

Creates a copy of address

Since: 1.32

equal

iPAddressEqual

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> IPAddress

other: the IPAddress to compare address to.

-> m Bool

Returns: True if the objects contain the same values, False if they do not.

Determines if two IPAddress objects contain the same address and prefix (attributes are not compared).

getAddress

iPAddressGetAddress

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m Text

Returns: the IP address

Gets the IP address property of this address object.

getAttribute

iPAddressGetAttribute

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> Text

name: the name of an address attribute

-> m GVariant

Returns: the value of the attribute with name name on address, or Nothing if address has no such attribute.

Gets the value of the attribute with name name on address

getAttributeNames

iPAddressGetAttributeNames

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m [Text]

Returns: a Nothing-terminated array of attribute names,

Gets an array of attribute names defined on address.

getFamily

iPAddressGetFamily

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m Int32

Returns: the IP address family

Gets the IP address family (eg, AF_INET) property of this address object.

getPrefix

iPAddressGetPrefix

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m Word32

Returns: the IP address prefix

Gets the IP address prefix (ie "24" or "30" etc) property of this address object.

new

iPAddressNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

family: the IP address family (<literal>AF_INET</literal> or <literal>AF_INET6</literal>)

-> Text

addr: the IP address

-> Word32

prefix: the address prefix length

-> m IPAddress

Returns: the new IPAddress object, or Nothing on error (Can throw GError)

Creates a new IPAddress object.

newBinary

iPAddressNewBinary

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

family: the IP address family (<literal>AF_INET</literal> or <literal>AF_INET6</literal>)

-> Ptr ()

addr: the IP address

-> Word32

prefix: the address prefix length

-> m IPAddress

Returns: the new IPAddress object, or Nothing on error (Can throw GError)

Creates a new IPAddress object. addr must point to a buffer of the correct size for family.

ref

iPAddressRef

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m ()

Increases the reference count of the object.

setAddress

iPAddressSetAddress

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> Text

addr: the IP address, as a string

-> m ()

Sets the IP address property of this address object.

addr must be a valid address of address's family. If you aren't sure you have a valid address, use utilsIpaddrValid to check it.

setAttribute

iPAddressSetAttribute

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> Text

name: the name of an address attribute

-> Maybe GVariant

value: the value

-> m ()

Sets or clears the named attribute on address to the given value.

setPrefix

iPAddressSetPrefix

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> Word32

prefix: the IP address prefix

-> m ()

Sets the IP address prefix property of this address object.

unref

iPAddressUnref

Arguments

:: (HasCallStack, MonadIO m)

=> IPAddress

address: the IPAddress

-> m ()

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.