GI.Gio.Objects.InetAddressMask

InetAddressMask represents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the base address are relevant for matching purposes. These are often given in string form. Eg, "10.0.0.0/8", or "fe80::/10".

Since: 2.32

Exported types

newtype InetAddressMask

Memory-managed wrapper type.

Constructors

InetAddressMask (ManagedPtr InetAddressMask)

Instances

Eq InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

Methods

(==) :: InetAddressMask -> InetAddressMask -> Bool

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

GObject InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

ManagedPtrNewtype InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

Methods

toManagedPtr :: InetAddressMask -> ManagedPtr InetAddressMask

TypedObject InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

Methods

glibType :: IO GType

HasParentTypes InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

IsGValue (Maybe InetAddressMask)

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

Defined in GI.Gio.Objects.InetAddressMask

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes InetAddressMask

Defined in GI.Gio.Objects.InetAddressMask

type ParentTypes InetAddressMask = '[Object, Initable]

class (GObject o, IsDescendantOf InetAddressMask o) => IsInetAddressMask o

Type class for types which can be safely cast to InetAddressMask, for instance with toInetAddressMask.

Instances

(GObject o, IsDescendantOf InetAddressMask o) => IsInetAddressMask o

Defined in GI.Gio.Objects.InetAddressMask

toInetAddressMask :: (MonadIO m, IsInetAddressMask o) => o -> m InetAddressMask

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, equal, forceFloating, freezeNotify, getv, init, isFloating, matches, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, watchClosure.

Getters

getAddress, getData, getFamily, getLength, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

equal

inetAddressMaskEqual

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddressMask b)

=> a

mask: a InetAddressMask

-> b

mask2: another InetAddressMask

-> m Bool

Returns: whether mask and mask2 are the same mask

Tests if mask and mask2 are the same mask.

Since: 2.32

getAddress

inetAddressMaskGetAddress

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a)

=> a

mask: a InetAddressMask

-> m InetAddress

Returns: mask's base address

Gets mask's base address

Since: 2.32

getFamily

inetAddressMaskGetFamily

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a)

=> a

mask: a InetAddressMask

-> m SocketFamily

Returns: the SocketFamily of mask's address

Gets the SocketFamily of mask's address

Since: 2.32

getLength

inetAddressMaskGetLength

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a)

=> a

mask: a InetAddressMask

-> m Word32

Returns: mask's length

Gets mask's length

Since: 2.32

matches

inetAddressMaskMatches

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddress b)

=> a

mask: a InetAddressMask

-> b

address: a InetAddress

-> m Bool

Returns: whether address falls within the range described by mask.

Tests if address falls within the range described by mask.

Since: 2.32

new

inetAddressMaskNew

Arguments

:: (HasCallStack, MonadIO m, IsInetAddress a)

=> a

addr: a InetAddress

-> Word32

length: number of bits of addr to use

-> m InetAddressMask

Returns: a new InetAddressMask, or Nothing on error (Can throw GError)

Creates a new InetAddressMask representing all addresses whose first length bits match addr.

Since: 2.32

newFromString

inetAddressMaskNewFromString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

maskString: an IP address or address/length string

-> m InetAddressMask

Returns: a new InetAddressMask corresponding to string, or Nothing on error. (Can throw GError)

Parses maskString as an IP address and (optional) length, and creates a new InetAddressMask. The length, if present, is delimited by a "/". If it is not present, then the length is assumed to be the full length of the address.

Since: 2.32

toString

inetAddressMaskToString

Arguments

:: (HasCallStack, MonadIO m, IsInetAddressMask a)

=> a

mask: a InetAddressMask

-> m Text

Returns: a string corresponding to mask.

Converts mask back to its corresponding string form.

Since: 2.32

Properties

address

No description available in the introspection data.

clearInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o) => o -> m ()

Set the value of the “address” property to Nothing. When overloading is enabled, this is equivalent to

clear #address

constructInetAddressMaskAddress :: (IsInetAddressMask o, MonadIO m, IsInetAddress a) => a -> m (GValueConstruct o)

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

getInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o) => o -> m InetAddress

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

get inetAddressMask #address

setInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o, IsInetAddress a) => o -> a -> m ()

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

set inetAddressMask [ #address := value ]

family

No description available in the introspection data.

getInetAddressMaskFamily :: (MonadIO m, IsInetAddressMask o) => o -> m SocketFamily

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

get inetAddressMask #family

length

No description available in the introspection data.

constructInetAddressMaskLength :: (IsInetAddressMask o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getInetAddressMaskLength :: (MonadIO m, IsInetAddressMask o) => o -> m Word32

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

get inetAddressMask #length

setInetAddressMaskLength :: (MonadIO m, IsInetAddressMask o) => o -> Word32 -> m ()

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

set inetAddressMask [ #length := value ]