Struct Value

pub struct Value { /* private fields */ }

A value containing a secret

A #SecretValue contains a password or other secret value.

Use get() to get the actual secret data, such as a password. The secret data is not necessarily null-terminated, unless the content type is “text/plain”.

Each #SecretValue has a content type. For passwords, this is text/plain. Use content_type() to look at the content type.

#SecretValue is reference counted and immutable. The secret data is only freed when all references have been released via Value::unref().

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl Value

pub fn as_ptr(&self) -> *mut SecretValue

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut SecretValue) -> &Self

Borrows the underlying C value.

impl Value

pub fn new(secret: &str, content_type: &str) -> Value

Create a #SecretValue for the secret data passed in.

The secret data is copied into non-pageable ‘secure’ memory.

If the length is less than zero, then @secret is assumed to be null-terminated.

secret

the secret data

length

the length of the data

content_type

the content type of the data

Returns

the new #SecretValue

pub fn get(&self) -> Vec<u8>

Get the secret data in the #SecretValue.

The value is not necessarily null-terminated unless it was created with Value::new() or a null-terminated string was passed to Value::new_full().

Returns

the secret data

pub fn content_type(&self) -> GString

Get the content type of the secret value, such as text/plain.

Returns

the content type

pub fn text(&self) -> Option<GString>

Get the secret data in the #SecretValue if it contains a textual value.

The content type must be text/plain.

Returns

the content type

pub fn unref_to_password(&self) -> GString

Unreference a #SecretValue and steal the secret data in #SecretValue as nonpageable memory.

length

the length of the secret

Returns

a new password string stored in nonpageable memory which must be freed with password_free() when done

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Value

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Value> for Value

fn from(s: Value) -> Self

Converts to this type from the input type.

impl HasParamSpec for Value

type ParamSpec = ParamSpecBoxed

type SetValue = Value

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Value>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Value

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Value

fn cmp(&self, other: &Value) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Value) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Value

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Value

impl StructuralPartialEq for Value