GI.Secret.Structs.Schema

Represents a set of attributes that are stored with an item. These schemas are used for interoperability between various services storing the same types of items.

Each schema has a name like "org.gnome.keyring.NetworkPassword", and defines a set of attributes, and types (string, integer, boolean) for those attributes.

Attributes are stored as strings in the Secret Service, and the attribute types simply define standard ways to store integer and boolean values as strings. Attributes are represented in libsecret via a HashTable with string keys and values. Even for values that defined as an integer or boolean in the schema, the attribute values in the HashTable are strings. Boolean values are stored as the strings 'true' and 'false'. Integer values are stored in decimal, with a preceding negative sign for negative integers.

Schemas are handled entirely on the client side by this library. The name of the schema is automatically stored as an attribute on the item.

Normally when looking up passwords only those with matching schema names are returned. If the schema flags contain the SchemaFlagsDontMatchName flag, then lookups will not check that the schema name matches that on the item, only the schema's attributes are matched. This is useful when you are looking up items that are not stored by the libsecret library. Other libraries such as libgnome-keyring don't store the schema name.

Exported types

newtype Schema

Memory-managed wrapper type.

Constructors

Schema (ManagedPtr Schema)

Instances

Eq Schema

Defined in GI.Secret.Structs.Schema

Methods

(==) :: Schema -> Schema -> Bool

(/=) :: Schema -> Schema -> Bool

GBoxed Schema

Defined in GI.Secret.Structs.Schema

ManagedPtrNewtype Schema

Defined in GI.Secret.Structs.Schema

Methods

toManagedPtr :: Schema -> ManagedPtr Schema

TypedObject Schema

Defined in GI.Secret.Structs.Schema

Methods

glibType :: IO GType

IsGValue Schema

Convert Schema to and from GValue with toGValue and fromGValue.

Defined in GI.Secret.Structs.Schema

Methods

toGValue :: Schema -> IO GValue

fromGValue :: GValue -> IO Schema

HasParentTypes Schema

Defined in GI.Secret.Structs.Schema

tag ~ 'AttrSet => Constructible Schema tag

Defined in GI.Secret.Structs.Schema

Methods

new :: MonadIO m => (ManagedPtr Schema -> Schema) -> [AttrOp Schema tag] -> m Schema

type ParentTypes Schema

Defined in GI.Secret.Structs.Schema

type ParentTypes Schema = '[] :: [Type]

newZeroSchema :: MonadIO m => m Schema

Construct a Schema struct initialized to zero.

Methods

Overloaded methods

ref

schemaRef

Arguments

:: (HasCallStack, MonadIO m)

=> Schema

schema: the schema to reference

-> m Schema

Returns: the referenced schema, which should be later unreferenced with schemaUnref

Adds a reference to the Schema.

It is not normally necessary to call this function from C code, and is mainly present for the sake of bindings. If the schema was statically allocated, then this function will copy the schema.

unref

schemaUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Schema

schema: the schema to reference

-> m ()

Releases a reference to the Schema. If the last reference is released then the schema will be freed.

It is not normally necessary to call this function from C code, and is mainly present for the sake of bindings. It is an error to call this for a schema that was statically allocated.

Properties

flags

flags for the schema

getSchemaFlags :: MonadIO m => Schema -> m [SchemaFlags]

Get the value of the “flags” field. When overloading is enabled, this is equivalent to

get schema #flags

setSchemaFlags :: MonadIO m => Schema -> [SchemaFlags] -> m ()

Set the value of the “flags” field. When overloading is enabled, this is equivalent to

set schema [ #flags := value ]

name

the dotted name of the schema

clearSchemaName :: MonadIO m => Schema -> m ()

Set the value of the “name” field to Nothing. When overloading is enabled, this is equivalent to

clear #name

getSchemaName :: MonadIO m => Schema -> m (Maybe Text)

Get the value of the “name” field. When overloading is enabled, this is equivalent to

get schema #name

setSchemaName :: MonadIO m => Schema -> CString -> m ()

Set the value of the “name” field. When overloading is enabled, this is equivalent to

set schema [ #name := value ]