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 |
Holds a password used in TLS.
- newtype TlsPassword = TlsPassword (ManagedPtr TlsPassword)
- class GObject o => IsTlsPassword o
- toTlsPassword :: IsTlsPassword o => o -> IO TlsPassword
- noTlsPassword :: Maybe TlsPassword
- data TlsPasswordGetDescriptionMethodInfo
- tlsPasswordGetDescription :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m Text
- data TlsPasswordGetFlagsMethodInfo
- tlsPasswordGetFlags :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m [TlsPasswordFlags]
- data TlsPasswordGetWarningMethodInfo
- tlsPasswordGetWarning :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> m Text
- tlsPasswordNew :: (HasCallStack, MonadIO m) => [TlsPasswordFlags] -> Text -> m TlsPassword
- data TlsPasswordSetDescriptionMethodInfo
- tlsPasswordSetDescription :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Text -> m ()
- data TlsPasswordSetFlagsMethodInfo
- tlsPasswordSetFlags :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> [TlsPasswordFlags] -> m ()
- data TlsPasswordSetValueMethodInfo
- tlsPasswordSetValue :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Word8 -> Int64 -> m ()
- data TlsPasswordSetValueFullMethodInfo
- tlsPasswordSetValueFull :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Word8 -> Int64 -> Maybe DestroyNotify -> m ()
- data TlsPasswordSetWarningMethodInfo
- tlsPasswordSetWarning :: (HasCallStack, MonadIO m, IsTlsPassword a) => a -> Text -> m ()
- data TlsPasswordDescriptionPropertyInfo
- constructTlsPasswordDescription :: IsTlsPassword o => Text -> IO (GValueConstruct o)
- getTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> m Text
- setTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()
- tlsPasswordDescription :: AttrLabelProxy "description"
- data TlsPasswordFlagsPropertyInfo
- constructTlsPasswordFlags :: IsTlsPassword o => [TlsPasswordFlags] -> IO (GValueConstruct o)
- getTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> m [TlsPasswordFlags]
- setTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> [TlsPasswordFlags] -> m ()
- tlsPasswordFlags :: AttrLabelProxy "flags"
- data TlsPasswordWarningPropertyInfo
- constructTlsPasswordWarning :: IsTlsPassword o => Text -> IO (GValueConstruct o)
- getTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> m Text
- setTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()
- tlsPasswordWarning :: AttrLabelProxy "warning"
Exported types
newtype TlsPassword Source #
GObject TlsPassword Source # | |
IsObject TlsPassword Source # | |
IsTlsPassword TlsPassword Source # | |
((~) * info (ResolveTlsPasswordMethod t TlsPassword), MethodInfo * info TlsPassword p) => IsLabel t (TlsPassword -> p) Source # | |
((~) * info (ResolveTlsPasswordMethod t TlsPassword), MethodInfo * info TlsPassword p) => IsLabelProxy t (TlsPassword -> p) Source # | |
HasAttributeList * TlsPassword Source # | |
type AttributeList TlsPassword Source # | |
type SignalList TlsPassword Source # | |
class GObject o => IsTlsPassword o Source #
toTlsPassword :: IsTlsPassword o => o -> IO TlsPassword Source #
Methods
getDescription
data TlsPasswordGetDescriptionMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordGetDescriptionMethodInfo a signature Source # | |
tlsPasswordGetDescription Source #
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> m Text | Returns: The description of the password. |
Get a description string about what the password will be used for.
Since: 2.30
getFlags
data TlsPasswordGetFlagsMethodInfo Source #
((~) * signature (m [TlsPasswordFlags]), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordGetFlagsMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> m [TlsPasswordFlags] | Returns: The flags about the password. |
Get flags about the password.
Since: 2.30
getWarning
data TlsPasswordGetWarningMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordGetWarningMethodInfo a signature Source # | |
tlsPasswordGetWarning Source #
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> m Text | Returns: The warning. |
Get a user readable translated warning. Usually this warning is a
representation of the password flags returned from
tlsPasswordGetFlags
.
Since: 2.30
new
:: (HasCallStack, MonadIO m) | |
=> [TlsPasswordFlags] |
|
-> Text |
|
-> m TlsPassword | Returns: The newly allocated password object |
Create a new TlsPassword
object.
setDescription
data TlsPasswordSetDescriptionMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordSetDescriptionMethodInfo a signature Source # | |
tlsPasswordSetDescription Source #
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> Text |
|
-> m () |
Set a description string about what the password will be used for.
Since: 2.30
setFlags
data TlsPasswordSetFlagsMethodInfo Source #
((~) * signature ([TlsPasswordFlags] -> m ()), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordSetFlagsMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> [TlsPasswordFlags] |
|
-> m () |
Set flags about the password.
Since: 2.30
setValue
data TlsPasswordSetValueMethodInfo Source #
((~) * signature (Word8 -> Int64 -> m ()), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordSetValueMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> Word8 |
|
-> Int64 |
|
-> m () |
Set the value for this password. The value
will be copied by the password
object.
Specify the length
, for a non-nul-terminated password. Pass -1 as
length
if using a nul-terminated password, and length
will be
calculated automatically. (Note that the terminating nul is not
considered part of the password in this case.)
Since: 2.30
setValueFull
data TlsPasswordSetValueFullMethodInfo Source #
((~) * signature (Word8 -> Int64 -> Maybe DestroyNotify -> m ()), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordSetValueFullMethodInfo a signature Source # | |
tlsPasswordSetValueFull Source #
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> Word8 |
|
-> Int64 |
|
-> Maybe DestroyNotify |
|
-> m () |
Provide the value for this password.
The value
will be owned by the password object, and later freed using
the destroy
function callback.
Specify the length
, for a non-nul-terminated password. Pass -1 as
length
if using a nul-terminated password, and length
will be
calculated automatically. (Note that the terminating nul is not
considered part of the password in this case.)
Since: 2.30
setWarning
data TlsPasswordSetWarningMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m, IsTlsPassword a) => MethodInfo * TlsPasswordSetWarningMethodInfo a signature Source # | |
tlsPasswordSetWarning Source #
:: (HasCallStack, MonadIO m, IsTlsPassword a) | |
=> a |
|
-> Text |
|
-> m () |
Set a user readable translated warning. Usually this warning is a
representation of the password flags returned from
tlsPasswordGetFlags
.
Since: 2.30
Properties
description
data TlsPasswordDescriptionPropertyInfo Source #
constructTlsPasswordDescription :: IsTlsPassword o => Text -> IO (GValueConstruct o) Source #
getTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> m Text Source #
setTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> Text -> m () Source #
tlsPasswordDescription :: AttrLabelProxy "description" Source #
flags
data TlsPasswordFlagsPropertyInfo Source #
constructTlsPasswordFlags :: IsTlsPassword o => [TlsPasswordFlags] -> IO (GValueConstruct o) Source #
getTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> m [TlsPasswordFlags] Source #
setTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> [TlsPasswordFlags] -> m () Source #
tlsPasswordFlags :: AttrLabelProxy "flags" Source #
warning
data TlsPasswordWarningPropertyInfo Source #
constructTlsPasswordWarning :: IsTlsPassword o => Text -> IO (GValueConstruct o) Source #
getTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> m Text Source #
setTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> Text -> m () Source #
tlsPasswordWarning :: AttrLabelProxy "warning" Source #