GI.Secret.Structs.Value

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

Exported types

newtype Value

Memory-managed wrapper type.

Constructors

Value (ManagedPtr Value)

Instances

BoxedObject Value

Defined in GI.Secret.Structs.Value

Methods

boxedType :: Value -> IO GType

noValue :: Maybe Value

A convenience alias for Nothing :: Maybe Value.

Methods

get

valueGet

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

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

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

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

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

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

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.