| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Secret.Structs.Value
Description
A value containing a secret
A Value contains a password or other secret value.
Use [methodvalue.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 Value has a content type. For passwords, this is text/plain.
Use [methodvalue.get_content_type] to look at the content type.
Value is reference counted and immutable. The secret data is only
freed when all references have been released via [methodvalue.unref].
Synopsis
- newtype Value = Value (ManagedPtr Value)
- valueGet :: (HasCallStack, MonadIO m) => Value -> m ByteString
- valueGetContentType :: (HasCallStack, MonadIO m) => Value -> m Text
- valueGetText :: (HasCallStack, MonadIO m) => Value -> m (Maybe Text)
- valueNew :: (HasCallStack, MonadIO m) => Text -> Int64 -> Text -> m Value
- valueNewFull :: (HasCallStack, MonadIO m) => Text -> Int64 -> Text -> DestroyNotify -> m Value
- valueRef :: (HasCallStack, MonadIO m) => Value -> m Value
- valueUnref :: (HasCallStack, MonadIO m) => Value -> m ()
- valueUnrefToPassword :: (HasCallStack, MonadIO m) => Value -> CSize -> m (Text, CSize)
Exported types
Memory-managed wrapper type.
Instances
| Eq Value Source # | |
| GBoxed Value Source # | |
Defined in GI.Secret.Structs.Value | |
| ManagedPtrNewtype Value Source # | |
Defined in GI.Secret.Structs.Value Methods toManagedPtr :: Value -> ManagedPtr Value | |
| TypedObject Value Source # | |
Defined in GI.Secret.Structs.Value | |
| HasParentTypes Value Source # | |
Defined in GI.Secret.Structs.Value | |
| IsGValue (Maybe Value) Source # | Convert |
Defined in GI.Secret.Structs.Value Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Value -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Value) | |
| type ParentTypes Value Source # | |
Defined in GI.Secret.Structs.Value | |
Methods
Click to display all available methods, including inherited ones
get
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Value |
|
| -> m ByteString | Returns: the secret data |
Get the secret data in the Value.
The value is not necessarily null-terminated unless it was created with
[ctorvalue.new] or a null-terminated string was passed to
[ctorvalue.new_full].
getContentType
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Value |
|
| -> m Text | Returns: the content type |
Get the content type of the secret value, such as
text/plain.
getText
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Value |
|
| -> m (Maybe Text) | Returns: the content type |
Get the secret data in the Value if it contains a textual
value.
The content type must be text/plain.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> Int64 |
|
| -> Text |
|
| -> m Value | Returns: the new |
Create a Value 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.
newFull
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> Int64 |
|
| -> Text |
|
| -> DestroyNotify |
|
| -> m Value | Returns: the new |
Create a Value for the secret data passed in.
The secret data is not copied, and will later be freed with the destroy
function.
If the length is less than zero, then secret is assumed to be
null-terminated.
ref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Value |
|
| -> m Value | Returns: the value |
Add another reference to the Value.
For each reference [methodvalue.unref] should be called to unreference the
value.
unref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Value |
|
| -> m () |
Unreference a Value.
When the last reference is gone, then the value will be freed.