GI.Gio.Objects.TlsPassword

Holds a password used in TLS.

Exported types

newtype TlsPassword

Constructors

TlsPassword (ManagedPtr TlsPassword)

Instances

GObject TlsPassword

Methods

gobjectType :: TlsPassword -> IO GType

IsObject TlsPassword

IsTlsPassword TlsPassword

class GObject o => IsTlsPassword o

Instances

(GObject a, UnknownAncestorError Constraint TlsPassword a) => IsTlsPassword a

IsTlsPassword TlsPassword

toTlsPassword :: (MonadIO m, IsTlsPassword o) => o -> m TlsPassword

noTlsPassword :: Maybe TlsPassword

Methods

getDescription

tlsPasswordGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> m Text

Returns: The description of the password.

Get a description string about what the password will be used for.

Since: 2.30

getFlags

tlsPasswordGetFlags

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> m [TlsPasswordFlags]

Returns: The flags about the password.

Get flags about the password.

Since: 2.30

getWarning

tlsPasswordGetWarning

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> 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

tlsPasswordNew

Arguments

:: (HasCallStack, MonadIO m)

=> [TlsPasswordFlags]

flags: the password flags

-> Text

description: description of what the password is for

-> m TlsPassword

Returns: The newly allocated password object

Create a new TlsPassword object.

setDescription

tlsPasswordSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> Text

description: The description of the password

-> m ()

Set a description string about what the password will be used for.

Since: 2.30

setFlags

tlsPasswordSetFlags

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> [TlsPasswordFlags]

flags: The flags about the password

-> m ()

Set flags about the password.

Since: 2.30

setValue

tlsPasswordSetValue

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> Word8

value: the new password value

-> Int64

length: the length of the password, or -1

-> 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

tlsPasswordSetValueFull

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> Word8

value: the value for the password

-> Int64

length: the length of the password, or -1

-> Maybe DestroyNotify

destroy: a function to use to free the password.

-> 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

tlsPasswordSetWarning

Arguments

:: (HasCallStack, MonadIO m, IsTlsPassword a)

=> a

password: a TlsPassword object

-> Text

warning: The user readable warning

-> 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

constructTlsPasswordDescription :: IsTlsPassword o => Text -> IO (GValueConstruct o)

getTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> m Text

setTlsPasswordDescription :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()

flags

constructTlsPasswordFlags :: IsTlsPassword o => [TlsPasswordFlags] -> IO (GValueConstruct o)

getTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> m [TlsPasswordFlags]

setTlsPasswordFlags :: (MonadIO m, IsTlsPassword o) => o -> [TlsPasswordFlags] -> m ()

warning

constructTlsPasswordWarning :: IsTlsPassword o => Text -> IO (GValueConstruct o)

getTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> m Text

setTlsPasswordWarning :: (MonadIO m, IsTlsPassword o) => o -> Text -> m ()