| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.InetAddressMask
Description
GInetAddressMask 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. For example, 10.0.0.0/8, or fe80::/10.
Since: 2.32
Synopsis
- newtype InetAddressMask = InetAddressMask (ManagedPtr InetAddressMask)
- class (GObject o, IsDescendantOf InetAddressMask o) => IsInetAddressMask o
- toInetAddressMask :: (MonadIO m, IsInetAddressMask o) => o -> m InetAddressMask
- type family ResolveInetAddressMaskMethod (t :: Symbol) o where ...
- data InetAddressMaskEqualMethodInfo
- inetAddressMaskEqual :: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddressMask b) => a -> b -> m Bool
- data InetAddressMaskGetAddressMethodInfo
- inetAddressMaskGetAddress :: (HasCallStack, MonadIO m, IsInetAddressMask a) => a -> m InetAddress
- data InetAddressMaskGetFamilyMethodInfo
- inetAddressMaskGetFamily :: (HasCallStack, MonadIO m, IsInetAddressMask a) => a -> m SocketFamily
- data InetAddressMaskGetLengthMethodInfo
- inetAddressMaskGetLength :: (HasCallStack, MonadIO m, IsInetAddressMask a) => a -> m Word32
- data InetAddressMaskMatchesMethodInfo
- inetAddressMaskMatches :: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddress b) => a -> b -> m Bool
- inetAddressMaskNew :: (HasCallStack, MonadIO m, IsInetAddress a) => a -> Word32 -> m InetAddressMask
- inetAddressMaskNewFromString :: (HasCallStack, MonadIO m) => Text -> m InetAddressMask
- data InetAddressMaskToStringMethodInfo
- inetAddressMaskToString :: (HasCallStack, MonadIO m, IsInetAddressMask a) => a -> m Text
- data InetAddressMaskAddressPropertyInfo
- clearInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o) => o -> m ()
- constructInetAddressMaskAddress :: (IsInetAddressMask o, MonadIO m, IsInetAddress a) => a -> m (GValueConstruct o)
- getInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o) => o -> m InetAddress
- inetAddressMaskAddress :: AttrLabelProxy "address"
- setInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o, IsInetAddress a) => o -> a -> m ()
- data InetAddressMaskFamilyPropertyInfo
- getInetAddressMaskFamily :: (MonadIO m, IsInetAddressMask o) => o -> m SocketFamily
- inetAddressMaskFamily :: AttrLabelProxy "family"
- data InetAddressMaskLengthPropertyInfo
- constructInetAddressMaskLength :: (IsInetAddressMask o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getInetAddressMaskLength :: (MonadIO m, IsInetAddressMask o) => o -> m Word32
- inetAddressMaskLength :: AttrLabelProxy "length"
- setInetAddressMaskLength :: (MonadIO m, IsInetAddressMask o) => o -> Word32 -> m ()
Exported types
newtype InetAddressMask Source #
Memory-managed wrapper type.
Constructors
| InetAddressMask (ManagedPtr InetAddressMask) |
Instances
class (GObject o, IsDescendantOf InetAddressMask o) => IsInetAddressMask o Source #
Type class for types which can be safely cast to InetAddressMask, for instance with toInetAddressMask.
Instances
| (GObject o, IsDescendantOf InetAddressMask o) => IsInetAddressMask o Source # | |
Defined in GI.Gio.Objects.InetAddressMask | |
toInetAddressMask :: (MonadIO m, IsInetAddressMask o) => o -> m InetAddressMask Source #
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
type family ResolveInetAddressMaskMethod (t :: Symbol) o where ... Source #
Equations
equal
data InetAddressMaskEqualMethodInfo Source #
Instances
| (signature ~ (b -> m Bool), MonadIO m, IsInetAddressMask a, IsInetAddressMask b) => OverloadedMethod InetAddressMaskEqualMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskEqualMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddressMask b) | |
| => a |
|
| -> b |
|
| -> m Bool | Returns: whether |
Tests if mask and mask2 are the same mask.
Since: 2.32
getAddress
data InetAddressMaskGetAddressMethodInfo Source #
Instances
| (signature ~ m InetAddress, MonadIO m, IsInetAddressMask a) => OverloadedMethod InetAddressMaskGetAddressMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskGetAddressMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
inetAddressMaskGetAddress Source #
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a) | |
| => a |
|
| -> m InetAddress | Returns: |
Gets mask's base address
Since: 2.32
getFamily
data InetAddressMaskGetFamilyMethodInfo Source #
Instances
| (signature ~ m SocketFamily, MonadIO m, IsInetAddressMask a) => OverloadedMethod InetAddressMaskGetFamilyMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskGetFamilyMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
inetAddressMaskGetFamily Source #
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a) | |
| => a |
|
| -> m SocketFamily | Returns: the |
Gets the SocketFamily of mask's address
Since: 2.32
getLength
data InetAddressMaskGetLengthMethodInfo Source #
Instances
| (signature ~ m Word32, MonadIO m, IsInetAddressMask a) => OverloadedMethod InetAddressMaskGetLengthMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskGetLengthMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
inetAddressMaskGetLength Source #
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a) | |
| => a |
|
| -> m Word32 | Returns: |
Gets mask's length
Since: 2.32
matches
data InetAddressMaskMatchesMethodInfo Source #
Instances
| (signature ~ (b -> m Bool), MonadIO m, IsInetAddressMask a, IsInetAddress b) => OverloadedMethod InetAddressMaskMatchesMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskMatchesMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
inetAddressMaskMatches Source #
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a, IsInetAddress b) | |
| => a |
|
| -> b |
|
| -> m Bool | Returns: whether |
Tests if address falls within the range described by mask.
Since: 2.32
new
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddress a) | |
| => a |
|
| -> Word32 |
|
| -> m InetAddressMask | Returns: a new |
Creates a new InetAddressMask representing all addresses whose
first length bits match addr.
Since: 2.32
newFromString
inetAddressMaskNewFromString Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> m InetAddressMask | Returns: a new |
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
data InetAddressMaskToStringMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsInetAddressMask a) => OverloadedMethod InetAddressMaskToStringMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo InetAddressMaskToStringMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.InetAddressMask Methods | |
inetAddressMaskToString Source #
Arguments
| :: (HasCallStack, MonadIO m, IsInetAddressMask a) | |
| => a |
|
| -> m Text | Returns: a string corresponding to |
Converts mask back to its corresponding string form.
Since: 2.32
Properties
address
The base address.
Since: 2.32
data InetAddressMaskAddressPropertyInfo Source #
Instances
clearInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o) => o -> m () Source #
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) Source #
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 Source #
Get the value of the “address” property.
When overloading is enabled, this is equivalent to
get inetAddressMask #address
inetAddressMaskAddress :: AttrLabelProxy "address" Source #
setInetAddressMaskAddress :: (MonadIO m, IsInetAddressMask o, IsInetAddress a) => o -> a -> m () Source #
Set the value of the “address” property.
When overloading is enabled, this is equivalent to
setinetAddressMask [ #address:=value ]
family
The address family (IPv4 or IPv6).
Since: 2.32
data InetAddressMaskFamilyPropertyInfo Source #
Instances
| AttrInfo InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask Associated Types
Methods attrGet :: AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo o => o -> IO (AttrGetType InetAddressMaskFamilyPropertyInfo) # attrSet :: (AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo o, AttrSetTypeConstraint InetAddressMaskFamilyPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo o, AttrSetTypeConstraint InetAddressMaskFamilyPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo o, AttrTransferTypeConstraint InetAddressMaskFamilyPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType InetAddressMaskFamilyPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrOrigin InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrTransferType InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint InetAddressMaskFamilyPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
getInetAddressMaskFamily :: (MonadIO m, IsInetAddressMask o) => o -> m SocketFamily Source #
Get the value of the “family” property.
When overloading is enabled, this is equivalent to
get inetAddressMask #family
inetAddressMaskFamily :: AttrLabelProxy "family" Source #
length
The prefix length, in bytes.
Since: 2.32
data InetAddressMaskLengthPropertyInfo Source #
Instances
| AttrInfo InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask Associated Types
Methods attrGet :: AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo o => o -> IO (AttrGetType InetAddressMaskLengthPropertyInfo) # attrSet :: (AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo o, AttrSetTypeConstraint InetAddressMaskLengthPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo o, AttrSetTypeConstraint InetAddressMaskLengthPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo o, AttrTransferTypeConstraint InetAddressMaskLengthPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType InetAddressMaskLengthPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrLabel InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.InetAddressMask | |||||||||||||||||||||||||||||||||
| type AttrOrigin InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint InetAddressMaskLengthPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructInetAddressMaskLength :: (IsInetAddressMask o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
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 Source #
Get the value of the “length” property.
When overloading is enabled, this is equivalent to
get inetAddressMask #length
inetAddressMaskLength :: AttrLabelProxy "length" Source #
setInetAddressMaskLength :: (MonadIO m, IsInetAddressMask o) => o -> Word32 -> m () Source #
Set the value of the “length” property.
When overloading is enabled, this is equivalent to
setinetAddressMask [ #length:=value ]