Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Secret.Structs.Value

Contents

Exported types
Methods

Description

A secret value, like a password or other binary secret.

Synopsis

newtype Value = Value (ManagedPtr Value)
noValue :: Maybe 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 ()

Exported types

newtype Value Source #

Memory-managed wrapper type.

Constructors

Value (ManagedPtr Value)

Instances

Instances details

Eq Value Source #
Instance details Defined in GI.Secret.Structs.Value Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
IsGValue Value Source #	Convert `Value` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Secret.Structs.Value Methods toGValue :: Value -> IO GValue # fromGValue :: GValue -> IO Value #
BoxedObject Value Source #
Instance details Defined in GI.Secret.Structs.Value Methods boxedType :: Value -> IO GType #

noValue :: Maybe Value Source #

A convenience alias for Nothing :: Maybe Value.

Methods

Overloaded methods

get

valueGet Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Value	`value`: the 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 valueNew or a null-terminated string was passed to valueNewFull.

getContentType

valueGetContentType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Value	`value`: the value
-> m Text	Returns: the content type

Get the content type of the secret value, such as <literal>text/plain</literal>.

getText

valueGetText Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Value	`value`: the 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 <literal>text/plain</literal>.

new

valueNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`secret`: the secret data
-> Int64	`length`: the length of the data
-> Text	`contentType`: the content type of the data
-> m Value	Returns: the new `Value`

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

valueNewFull Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`secret`: the secret data
-> Int64	`length`: the length of the data
-> Text	`contentType`: the content type of the data
-> DestroyNotify	`destroy`: function to call to free the secret data
-> m Value	Returns: the new `Value`

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

valueRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Value	`value`: value to reference
-> m Value	Returns: the value

Add another reference to the Value. For each reference valueUnref should be called to unreference the value.

unref

valueUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Value	`value`: value to unreference
-> m ()

Unreference a Value. When the last reference is gone, then the value will be freed.