Class: Gio::TlsPassword

Inherits:

Object

• Object
• Gio::TlsPassword

Defined in:

(unknown)

Overview

Class structure for GTls::Password.

Instance Method Summary

• #description ⇒ String

  Description of what the password is for.

• #description=(description) ⇒ String

  Description of what the password is for.

• #flags ⇒ Gio::TlsPasswordFlags

  Flags about the password.

• #flags=(flags) ⇒ Gio::TlsPasswordFlags

  Flags about the password.

• #get_value(length) ⇒ Array<Integer>

  Get the password value.

• #initialize(flags, description) ⇒ Gio::TlsPassword constructor

  Create a new GTls::Password object.

• #set_value(value, length) ⇒ nil

  Set the value for this password.

• #set_value_full(value, length, destroy) ⇒ nil

  Provide the value for this password.

• #warning ⇒ String

  Warning about the password.

• #warning=(warning) ⇒ String

  Warning about the password.

Constructor Details

#initialize(flags, description) ⇒ Gio::TlsPassword

Create a new GTls::Password object.

Parameters:

• flags (Gio::TlsPasswordFlags) —

  the password flags

• description (String) —

  description of what the password is for

Instance Method Details

#description ⇒ String

Description of what the password is for.

Returns:

• (String) —

  description

#description=(description) ⇒ String

Description of what the password is for.

Parameters:

• description (String)

Returns:

• (String) —

  description

• (String) —

  description

#flags ⇒ Gio::TlsPasswordFlags

Flags about the password.

Returns:

• (Gio::TlsPasswordFlags) —

  flags

#flags=(flags) ⇒ Gio::TlsPasswordFlags

Flags about the password.

Parameters:

• flags (Gio::TlsPasswordFlags)

Returns:

• (Gio::TlsPasswordFlags) —

  flags

• (Gio::TlsPasswordFlags) —

  flags

#get_value(length) ⇒ Array<Integer>

Get the password value. If length is not nil then it will be
filled in with the length of the password value. (Note that the
password value is not nul-terminated, so you can only pass nil
for length in contexts where you know the password will have a
certain fixed length.)

Parameters:

• length (Integer) —

  location to place the length of the password.

Returns:

• (Array<Integer>) —

  The password value (owned by the password object).

#set_value(value, length) ⇒ nil

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

Parameters:

• value (Array<Integer>) —

  the new password value

• length (Gio::gssize) —

  the length of the password, or -1

Returns:

• (nil)

#set_value_full(value, length, destroy) ⇒ nil

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

Parameters:

• value (Array<Integer>) —

  the value for the password

• length (Gio::gssize) —

  the length of the password, or -1

• destroy (GLib::DestroyNotify) —

  a function to use to free the password.

Returns:

• (nil)

#warning ⇒ String

Warning about the password.

Returns:

• (String) —

  warning

#warning=(warning) ⇒ String

Warning about the password.

Parameters:

• warning (String)

Returns:

• (String) —

  warning

• (String) —

  warning