Class: Gio::TlsPassword

Inherits:

Object

• Object
• Gio::TlsPassword

Defined in:

(unknown)

Overview

Class structure for GTls::Password.

Instance Method Summary

• #description ⇒ String

  Description.

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

  Flags.

• #flags=(flags) ⇒ Gio::TlsPasswordFlags
• #get_value(length) ⇒ Integer

  Get the password value.

• #new(flags, description) ⇒ Gio::TlsPassword

  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.

• #warning=(warning) ⇒ String

Instance Method Details

#description ⇒ String

Returns description.

Returns:

• (String) —

  description

#description=(description) ⇒ String

Parameters:

• description (String)

Returns:

• (String) —

  description

• (String) —

  description

#flags ⇒ Gio::TlsPasswordFlags

Returns flags.

Returns:

• (Gio::TlsPasswordFlags) —

  flags

#flags=(flags) ⇒ Gio::TlsPasswordFlags

Parameters:

• flags (Gio::TlsPasswordFlags)

Returns:

• (Gio::TlsPasswordFlags) —

  flags

• (Gio::TlsPasswordFlags) —

  flags

#get_value(length) ⇒ 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:

• (Integer) —

  The password value (owned by the password object).

#new(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

Returns:

• (Gio::TlsPassword) —

  The newly allocated 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

Returns warning.

Returns:

• (String) —

  warning

#warning=(warning) ⇒ String

Parameters:

• warning (String)

Returns:

• (String) —

  warning

• (String) —

  warning