| 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.GLib.Structs.TrashStack
Description
Each piece of memory that is pushed onto the stack is cast to a GTrashStack*.
Synopsis
- newtype TrashStack = TrashStack (ManagedPtr TrashStack)
- newZeroTrashStack :: MonadIO m => m TrashStack
- noTrashStack :: Maybe TrashStack
- trashStackHeight :: (HasCallStack, MonadIO m) => TrashStack -> m Word32
- trashStackPeek :: (HasCallStack, MonadIO m) => TrashStack -> m (Ptr ())
- trashStackPop :: (HasCallStack, MonadIO m) => TrashStack -> m (Ptr ())
- trashStackPush :: (HasCallStack, MonadIO m) => TrashStack -> Ptr () -> m ()
- clearTrashStackNext :: MonadIO m => TrashStack -> m ()
- getTrashStackNext :: MonadIO m => TrashStack -> m (Maybe TrashStack)
- setTrashStackNext :: MonadIO m => TrashStack -> Ptr TrashStack -> m ()
Exported types
newtype TrashStack Source #
Memory-managed wrapper type.
Constructors
| TrashStack (ManagedPtr TrashStack) |
Instances
| Eq TrashStack Source # | |
Defined in GI.GLib.Structs.TrashStack | |
| WrappedPtr TrashStack Source # | |
Defined in GI.GLib.Structs.TrashStack | |
| tag ~ 'AttrSet => Constructible TrashStack tag Source # | |
Defined in GI.GLib.Structs.TrashStack Methods new :: MonadIO m => (ManagedPtr TrashStack -> TrashStack) -> [AttrOp TrashStack tag] -> m TrashStack # | |
newZeroTrashStack :: MonadIO m => m TrashStack Source #
Construct a TrashStack struct initialized to zero.
noTrashStack :: Maybe TrashStack Source #
A convenience alias for Nothing :: Maybe TrashStack.
Methods
Overloaded methods
height
Arguments
| :: (HasCallStack, MonadIO m) | |
| => TrashStack |
|
| -> m Word32 | Returns: the height of the stack |
Deprecated: (Since version 2.48)tTrashStack is deprecated without replacement
Returns the height of a TrashStack.
Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack.
peek
Arguments
| :: (HasCallStack, MonadIO m) | |
| => TrashStack |
|
| -> m (Ptr ()) | Returns: the element at the top of the stack |
Deprecated: (Since version 2.48)tTrashStack is deprecated without replacement
Returns the element at the top of a TrashStack
which may be Nothing.
pop
Arguments
| :: (HasCallStack, MonadIO m) | |
| => TrashStack |
|
| -> m (Ptr ()) | Returns: the element at the top of the stack |
Deprecated: (Since version 2.48)tTrashStack is deprecated without replacement
Pops a piece of memory off a TrashStack.
push
Arguments
| :: (HasCallStack, MonadIO m) | |
| => TrashStack |
|
| -> Ptr () |
|
| -> m () |
Deprecated: (Since version 2.48)tTrashStack is deprecated without replacement
Pushes a piece of memory onto a TrashStack.
Properties
next
pointer to the previous element of the stack,
gets stored in the first sizeof (gpointer)
bytes of the element
clearTrashStackNext :: MonadIO m => TrashStack -> m () Source #
Set the value of the “next” field to Nothing.
When overloading is enabled, this is equivalent to
clear #next
getTrashStackNext :: MonadIO m => TrashStack -> m (Maybe TrashStack) Source #
Get the value of the “next” field.
When overloading is enabled, this is equivalent to
get trashStack #next
setTrashStackNext :: MonadIO m => TrashStack -> Ptr TrashStack -> m () Source #
Set the value of the “next” field.
When overloading is enabled, this is equivalent to
settrashStack [ #next:=value ]