Struct Collection

pub struct Collection { /* private fields */ }

A proxy object representing a collection of secrets in the Secret Service.

#SecretCollection represents a collection of secret items stored in the Secret Service.

A collection can be in a locked or unlocked state. Use SecretService::lock() or SecretService::unlock() to lock or unlock the collection.

Use the [items][struct@crate::SecretCollection#items] property or SecretCollection::get_items() to lookup the items in the collection. There may not be any items exposed when the collection is locked.

Properties

created

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

Readable | Writeable

flags

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

Readable | Writeable | Construct Only

label

The human readable label for the collection.

Setting this property will result in the label of the collection being set asynchronously. To properly track the changing of the label use the CollectionExt::set_label() function.

Readable | Writeable

locked

Whether the collection is locked or not.

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

Readable

modified

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

Readable | Writeable

service

The Service object that this collection 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

Implements

CollectionExt, [trait@gio::prelude::DBusProxyExt], [trait@gio::prelude::DBusInterfaceExt], [trait@gio::prelude::InitableExt], CollectionExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl Collection

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

pub fn for_dbus_path_sync( service: Option<&impl IsA<Service>>, collection_path: &str, flags: CollectionFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Collection, Error>

Get a new collection proxy for a collection 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

collection_path

the D-Bus path of the collection

flags

options for the collection initialization

cancellable

optional cancellation object

Returns

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

pub fn create<P: FnOnce(Result<Collection, Error>) + 'static>( service: Option<&impl IsA<Service>>, label: &str, alias: Option<&str>, flags: CollectionCreateFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Create a new collection in the secret service.

This method returns immediately and completes asynchronously. The secret service may prompt the user. ServiceExt::prompt() will be used to handle any prompts that are required.

An @alias is a well-known tag for a collection, such as ‘default’ (ie: the default collection to store items in). This allows other applications to easily identify and share a collection. If you specify an @alias, and a collection with that alias already exists, then a new collection will not be created. The previous one will be returned instead.

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

service

a secret service object

label

label for the new collection

alias

alias to assign to the collection

flags

currently unused

cancellable

optional cancellation object

callback

called when the operation completes

pub fn create_future( service: Option<&(impl IsA<Service> + Clone + 'static)>, label: &str, alias: Option<&str>, flags: CollectionCreateFlags, ) -> Pin<Box_<dyn Future<Output = Result<Collection, Error>> + 'static>>

pub fn create_sync( service: Option<&impl IsA<Service>>, label: &str, alias: Option<&str>, flags: CollectionCreateFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Collection, Error>

Create a new collection in the secret service.

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.

An @alias is a well-known tag for a collection, such as default (ie: the default collection to store items in). This allows other applications to easily identify and share a collection. If you specify an @alias, and a collection with that alias already exists, then a new collection will not be created. The previous one will be returned instead.

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

service

a secret service object

label

label for the new collection

alias

alias to assign to the collection

flags

currently unused

cancellable

optional cancellation object

Returns

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

pub fn for_alias<P: FnOnce(Result<Option<Collection>, Error>) + 'static>( service: Option<&impl IsA<Service>>, alias: &str, flags: CollectionFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as ‘default’.

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

alias

the alias to lookup

flags

options for the collection initialization

cancellable

optional cancellation object

callback

called when the operation completes

pub fn for_alias_future( service: Option<&(impl IsA<Service> + Clone + 'static)>, alias: &str, flags: CollectionFlags, ) -> Pin<Box_<dyn Future<Output = Result<Option<Collection>, Error>> + 'static>>

pub fn for_alias_sync( service: Option<&impl IsA<Service>>, alias: &str, flags: CollectionFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Option<Collection>, Error>

Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as default.

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

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

service

a secret service object

alias

the alias to lookup

flags

options for the collection initialization

cancellable

optional cancellation object

Returns

the collection, or None if none assigned to the alias

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

Get a new collection proxy for a collection 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

collection_path

the D-Bus path of the collection

flags

options for the collection initialization

cancellable

optional cancellation object

callback

called when the operation completes

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

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl HasParamSpec for Collection

type ParamSpec = ParamSpecObject

type SetValue = Collection

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Collection

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

where H: Hasher,

Hashes the memory address of this object.

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 Collection

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for Collection

type Parent = DBusProxy

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for Collection

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 Collection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Collection

impl IsA<DBusInterface> for Collection

impl IsA<DBusProxy> for Collection

impl IsA<Initable> for Collection