Struct Service

pub struct Service { /* private fields */ }

A proxy object representing the Secret Service.

A #SecretService object represents the Secret Service implementation which runs as a D-Bus service.

Normally a single #SecretService object can be shared between multiple callers. The get() method is used to access this #SecretService object. If a new independent #SecretService object is required, use open().

In order to securely transfer secrets to the Sercret Service, a session is established. This session can be established while initializing a #SecretService object by passing the ServiceFlags::OPEN_SESSION flag to the get() or open() functions. In order to establish a session on an already existing #SecretService, use the ServiceExt::ensure_session() function.

To search for items, use the ServiceExtManual::search() method.

Multiple collections can exist in the Secret Service, each of which contains secret items. In order to instantiate Collection objects which represent those collections while initializing a #SecretService then pass the ServiceFlags::LOAD_COLLECTIONS flag to the get() or open() functions. In order to establish a session on an already existing #SecretService, use the ServiceExt::load_collections() function. To access the list of collections use ServiceExt::collections().

Certain actions on the Secret Service require user prompting to complete, such as creating a collection, or unlocking a collection. When such a prompt is necessary, then a Prompt object is created by this library, and passed to the ServiceExt::prompt() method. In this way it is handled automatically.

In order to customize prompt handling, override the vfunc::Service::prompt_async and vfunc::Service::prompt_finish virtual methods of the #SecretService class.

Implements

ServiceExt, [trait@gio::prelude::DBusProxyExt], [trait@gio::prelude::DBusInterfaceExt], [trait@gio::prelude::InitableExt], ServiceExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl Service

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

pub fn disconnect()

Disconnect the default #SecretService proxy returned by get() and get_sync().

It is not necessary to call this function, but you may choose to do so at program exit. It is useful for testing that memory is not leaked.

This function is safe to call at any time. But if other objects in this library are still referenced, then this will not result in all memory being freed.

pub fn get<P: FnOnce(Result<Service, Error>) + 'static>( flags: ServiceFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Get a #SecretService proxy for the Secret Service.

If such a proxy object already exists, then the same proxy is returned.

If @flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before completing.

This method will return immediately and complete asynchronously.

flags

flags for which service functionality to ensure is initialized

cancellable

optional cancellation object

callback

called when the operation completes

pub fn get_future( flags: ServiceFlags, ) -> Pin<Box_<dyn Future<Output = Result<Service, Error>> + 'static>>

pub fn sync( flags: ServiceFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Service, Error>

Get a #SecretService proxy for the Secret Service.

If such a proxy object already exists, then the same proxy is returned.

If @flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

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

flags

flags for which service functionality to ensure is initialized

cancellable

optional cancellation object

Returns

a new reference to a #SecretService proxy, which should be released with GObject::Object::unref().

pub fn open<P: FnOnce(Result<Service, Error>) + 'static>( service_gtype: Type, service_bus_name: Option<&str>, flags: ServiceFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Create a new #SecretService proxy for the Secret Service.

This function is rarely used, see get() instead.

The @service_gtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If @flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If @service_bus_name is None then the default is used.

This method will return immediately and complete asynchronously.

service_gtype

the GType of the new secret service

service_bus_name

the D-Bus service name of the secret service

flags

flags for which service functionality to ensure is initialized

cancellable

optional cancellation object

callback

called when the operation completes

pub fn open_future( service_gtype: Type, service_bus_name: Option<&str>, flags: ServiceFlags, ) -> Pin<Box_<dyn Future<Output = Result<Service, Error>> + 'static>>

pub fn open_sync( service_gtype: Type, service_bus_name: Option<&str>, flags: ServiceFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Service, Error>

Create a new #SecretService proxy for the Secret Service.

This function is rarely used, see get_sync() instead.

The @service_gtype argument should be set to SECRET_TYPE_SERVICE or a the type of a derived class.

If @flags contains any flags of which parts of the secret service to ensure are initialized, then those will be initialized before returning.

If @service_bus_name is None then the default is used.

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

service_gtype

the GType of the new secret service

service_bus_name

the D-Bus service name of the secret service

flags

flags for which service functionality to ensure is initialized

cancellable

optional cancellation object

Returns

a new reference to a #SecretService proxy, which should be released with GObject::Object::unref().

Trait Implementations

impl Clone for Service

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 Service

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

Formats the value using the given formatter.

impl HasParamSpec for Service

type ParamSpec = ParamSpecObject

type SetValue = Service

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Service

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 Service

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 Service

type Parent = DBusProxy

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

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 Service

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 Service

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Service

impl IsA<DBusInterface> for Service

impl IsA<DBusProxy> for Service

impl IsA<Initable> for Service