GI.Gio.Objects.TlsPassword

Holds a password used in TLS.

Since: 2.30

Exported types

newtype TlsPassword

Memory-managed wrapper type.

Constructors

TlsPassword (ManagedPtr TlsPassword)

Instances

Eq TlsPassword

Defined in GI.Gio.Objects.TlsPassword

Methods

(==) :: TlsPassword -> TlsPassword -> Bool

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

IsGValue TlsPassword

Convert TlsPassword to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.TlsPassword

Methods

toGValue :: TlsPassword -> IO GValue

fromGValue :: GValue -> IO TlsPassword

ManagedPtrNewtype TlsPassword

Defined in GI.Gio.Objects.TlsPassword

Methods

toManagedPtr :: TlsPassword -> ManagedPtr TlsPassword

TypedObject TlsPassword

Defined in GI.Gio.Objects.TlsPassword

Methods

glibType :: IO GType

GObject TlsPassword

Defined in GI.Gio.Objects.TlsPassword

HasParentTypes TlsPassword

Defined in GI.Gio.Objects.TlsPassword

type ParentTypes TlsPassword

Defined in GI.Gio.Objects.TlsPassword

type ParentTypes TlsPassword = '[Object]

class (GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o

Type class for types which can be safely cast to TlsPassword, for instance with toTlsPassword.

Instances

(GObject o, IsDescendantOf TlsPassword o) => IsTlsPassword o

Defined in GI.Gio.Objects.TlsPassword

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

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

Methods

Overloaded 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

-> ByteString

value: the new password value

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

-> ByteString

value: the value for the password

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

No description available in the introspection data.

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

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

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

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

get tlsPassword #description

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

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

set tlsPassword [ #description := value ]

flags

No description available in the introspection data.

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

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

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

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

get tlsPassword #flags

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

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

set tlsPassword [ #flags := value ]

warning

No description available in the introspection data.

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

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

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

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

get tlsPassword #warning

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

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

set tlsPassword [ #warning := value ]