Struct libsecret::Item

pub struct Item { /* private fields */ }

A secret item

#SecretItem represents a secret item stored in the Secret Service.

Each item has a value, represented by a Value, which can be retrieved by ItemExt::secret() or set by ItemExt::set_secret(). The item is only available when the item is not locked.

Items can be locked or unlocked using the ServiceExtManual::lock() or ServiceExtManual::unlock() functions. The Secret Service may not be able to unlock individual items, and may unlock an entire collection when a single item is unlocked.

Each item has a set of attributes, which are used to locate the item later. These are not stored or transferred in a secure manner. Each attribute has a string name and a string value. Use ServiceExtManual::search() to search for items based on their attributes, and [ItemExtManual::set_attributes()][crate::prelude::ItemExtManual::set_attributes()] to change the attributes associated with an item.

Items can be created with create() or ServiceExtManual::store().

Properties

flags

A set of flags describing which parts of the secret item have been initialized.

Readable | Writeable | Construct Only

locked

Whether the item is locked or not.

An item may not be independently lockable separate from other items in its collection.

To lock or unlock a item use the ServiceExtManual::lock() or ServiceExtManual::unlock() functions.

Readable

service

The Service object that this item is associated with and uses to interact with the actual D-Bus Secret Service.

Readable | Writeable | Construct Only

DBusProxy

g-bus-type

If this property is not G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be None and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property.

Writeable | Construct Only

g-connection

The #GDBusConnection the proxy is for.

Readable | Writeable | Construct Only

g-default-timeout

The timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

This allows applications to set a proxy-wide timeout for all remote method invocations on the proxy. If this property is -1, the default timeout (typically 25 seconds) is used. If set to G_MAXINT, then no timeout is used.

Readable | Writeable | Construct

g-flags

Flags from the #GDBusProxyFlags enumeration.

Readable | Writeable | Construct Only

g-interface-info

Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the “expected interface”.

The checks performed are:

• When completing a method call, if the type signature of the reply message isn’t what’s expected, the reply is discarded and the #GError is set to G_IO_ERROR_INVALID_ARGUMENT.

• Received signals that have a type signature mismatch are dropped and a warning is logged via g_warning().

• Properties received via the initial GetAll() call or via the ::PropertiesChanged signal (on the org.freedesktop.DBus.Properties interface) or set using g_dbus_proxy_set_cached_property() with a type signature mismatch are ignored and a warning is logged via g_warning().

Note that these checks are never done on methods, signals and properties that are not referenced in the given #GDBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.

Readable | Writeable

g-interface-name

The D-Bus interface name the proxy is for.

Readable | Writeable | Construct Only

g-name

The well-known or unique name that the proxy is for.

Readable | Writeable | Construct Only

g-name-owner

The unique name that owns #GDBusProxy:g-name or None if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property.

Readable

g-object-path

The object path the proxy is for.

Readable | Writeable | Construct Only

Retrievable

attributes

The attributes set on this item.

Attributes are used to locate an item. They are not guaranteed to be stored or transferred securely.

Readable | Writeable

created

The date and time (in seconds since the UNIX epoch) that this item was created.

Readable | Writeable

label

The human readable label for the item.

Readable | Writeable

modified

The date and time (in seconds since the UNIX epoch) that this item was last modified.

Readable | Writeable

Implements

ItemExt, gio::prelude::DBusProxyExt, gio::prelude::DBusInterfaceExt, gio::prelude::InitableExt, RetrievableExt, RetrievableExtManual

Implementations

impl Item

pub const NONE: Option<&'static Item> = None

pub fn for_dbus_path_sync( service: Option<&impl IsA<Service>>, item_path: &str, flags: ItemFlags, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Item, Error>

Get a new item proxy for a secret item in the secret service.

If @service is None, then get_sync() will be called to get the default Service proxy.

This method may block indefinitely and should not be used in user interface threads.

service

a secret service object

item_path

the D-Bus path of the item

flags

initialization flags for the new item

cancellable

optional cancellation object

Returns

the new item, which should be unreferenced with GObject::Object::unref()

pub fn new_for_dbus_path<P: FnOnce(Result<Item, Error>) + 'static>( service: Option<&impl IsA<Service>>, item_path: &str, flags: ItemFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Get a new item proxy for a secret item in the secret service.

If @service is None, then get() will be called to get the default Service proxy.

This method will return immediately and complete asynchronously.

service

a secret service object

item_path

the D-Bus path of the collection

flags

initialization flags for the new item

cancellable

optional cancellation object

callback

called when the operation completes

pub fn new_for_dbus_path_future( service: Option<&(impl IsA<Service> + Clone + 'static)>, item_path: &str, flags: ItemFlags ) -> Pin<Box_<dyn Future<Output = Result<Item, Error>> + 'static>>

impl Item

pub fn attributes(&self) -> HashMap<String, String>

pub fn create_sync( collection: &impl IsA<Collection>, schema: Option<&Schema>, attributes: HashMap<&str, &str>, label: &str, value: &Value, flags: ItemCreateFlags, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Self, Error>

Create a new item in the secret service.

If the @flags contains ItemCreateFlags::REPLACE, then the secret service will search for an item matching the @attributes, and update that item instead of creating a new one.

This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. ServiceExt::prompt() will be used to handle any prompts that are required.

collection

a secret collection to create this item in

schema

the schema for the attributes

attributes

attributes for the new item

label

label for the new item

value

secret value for the new item

flags

flags for the creation of the new item

cancellable

optional cancellation object

Returns

the new item, which should be unreferenced with GObject::Object::unref()

pub fn load_secrets_sync( items: &[Item], cancellable: Option<&impl IsA<Cancellable>> ) -> Result<(), Error>

Load the secret values for a secret item stored in the service.

The @items must all have the same service property.

This method may block indefinitely and should not be used in user interface threads.

Items that are locked will not have their secrets loaded.

items

the items to retrieve secrets for

cancellable

optional cancellation object

Returns

whether the operation succeeded or not

pub fn load_secrets<P: FnOnce(Result<(), Error>) + 'static>( items: &[Item], cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Load the secret values for a secret item stored in the service.

The @items must all have the same service property.

This function returns immediately and completes asynchronously.

items

the items to retrieve secrets for

cancellable

optional cancellation object

callback

called when the operation completes

pub fn load_secrets_future( items: &[Item] ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn create<P: FnOnce(Result<Item, Error>) + 'static>( collection: &impl IsA<Collection>, schema: Option<&Schema>, attributes: HashMap<&str, &str>, label: &str, value: &Value, flags: ItemCreateFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Create a new item in the secret service.

If the @flags contains ItemCreateFlags::REPLACE, then the secret service will search for an item matching the @attributes, and update that item instead of creating a new one.

This method may block indefinitely and should not be used in user interface threads. The secret service may prompt the user. ServiceExt::prompt() will be used to handle any prompts that are required.

collection

a secret collection to create this item in

schema

the schema for the attributes

attributes

attributes for the new item

label

label for the new item

value

secret value for the new item

flags

flags for the creation of the new item

cancellable

optional cancellation object

callback

called when the operation completes

pub fn create_future( collection: &(impl IsA<Collection> + Clone + 'static), schema: Option<&Schema>, attributes: HashMap<String, &str>, label: &str, value: &Value, flags: ItemCreateFlags ) -> Pin<Box_<dyn Future<Output = Result<Item, Error>> + 'static>>

pub fn set_attributes<P: FnOnce(Result<(), Error>) + 'static>( &self, schema: Option<&Schema>, attributes: HashMap<&str, &str>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

pub fn set_attributes_future( &self, schema: Option<&Schema>, attributes: HashMap<&str, &str> ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn set_attributes_sync( &self, schema: Option<&Schema>, attributes: HashMap<&str, &str>, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<(), Error>

Trait Implementations

impl Clone for Item

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl HasParamSpec for Item

type ParamSpec = ParamSpecObject

type SetValue = Item

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Item>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Item

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

where H: Hasher,

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 Item

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Item

type Parent = DBusProxy

impl<OT: ObjectType> PartialEq<OT> for Item

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<OT: ObjectType> PartialOrd<OT> for Item

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Item

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Item

impl IsA<DBusInterface> for Item

impl IsA<DBusProxy> for Item

impl IsA<Initable> for Item

impl IsA<Retrievable> for Item