| 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.Vips.Structs.RefString
Description
No description available in the introspection data.
Synopsis
- newtype RefString = RefString (ManagedPtr RefString)
- newZeroRefString :: MonadIO m => m RefString
- refStringGet :: (HasCallStack, MonadIO m) => RefString -> Word64 -> m Text
- refStringNew :: (HasCallStack, MonadIO m) => Text -> m RefString
- getRefStringArea :: MonadIO m => RefString -> m Area
Exported types
Memory-managed wrapper type.
Instances
| Eq RefString Source # | |
| GBoxed RefString Source # | |
Defined in GI.Vips.Structs.RefString | |
| ManagedPtrNewtype RefString Source # | |
Defined in GI.Vips.Structs.RefString Methods toManagedPtr :: RefString -> ManagedPtr RefString | |
| TypedObject RefString Source # | |
Defined in GI.Vips.Structs.RefString | |
| HasParentTypes RefString Source # | |
Defined in GI.Vips.Structs.RefString | |
| tag ~ 'AttrSet => Constructible RefString tag Source # | |
| IsGValue (Maybe RefString) Source # | Convert |
Defined in GI.Vips.Structs.RefString Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe RefString -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe RefString) | |
| type ParentTypes RefString Source # | |
Defined in GI.Vips.Structs.RefString | |
newZeroRefString :: MonadIO m => m RefString Source #
Construct a RefString struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
get
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RefString |
|
| -> Word64 |
|
| -> m Text | Returns: The C string held by |
Get a pointer to the private string inside a refstr. Handy for language bindings.
See also: valueGetRefString.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Text |
|
| -> m RefString | Returns: the new |
Create a new refstring. These are reference-counted immutable strings, used to store string data in vips image metadata.
Strings must be valid utf-8; use blob for binary data.
See also: areaUnref.
Properties
area
No description available in the introspection data.
getRefStringArea :: MonadIO m => RefString -> m Area Source #
Get the value of the “area” field.
When overloading is enabled, this is equivalent to
get refString #area