GI.Poppler.Objects.Attachment

No description available in the introspection data.

Exported types

newtype Attachment

Memory-managed wrapper type.

Constructors

Attachment (ManagedPtr Attachment)

Instances

Eq Attachment

Defined in GI.Poppler.Objects.Attachment

Methods

(==) :: Attachment -> Attachment -> Bool

(/=) :: Attachment -> Attachment -> Bool

GObject Attachment

Defined in GI.Poppler.Objects.Attachment

ManagedPtrNewtype Attachment

Defined in GI.Poppler.Objects.Attachment

Methods

toManagedPtr :: Attachment -> ManagedPtr Attachment

TypedObject Attachment

Defined in GI.Poppler.Objects.Attachment

Methods

glibType :: IO GType

HasParentTypes Attachment

Defined in GI.Poppler.Objects.Attachment

IsGValue (Maybe Attachment)

Convert Attachment to and from GValue. See toGValue and fromGValue.

Defined in GI.Poppler.Objects.Attachment

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Attachment -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Attachment)

type ParentTypes Attachment

Defined in GI.Poppler.Objects.Attachment

type ParentTypes Attachment = '[Object]

class (GObject o, IsDescendantOf Attachment o) => IsAttachment o

Type class for types which can be safely cast to Attachment, for instance with toAttachment.

Instances

(GObject o, IsDescendantOf Attachment o) => IsAttachment o

Defined in GI.Poppler.Objects.Attachment

toAttachment :: (MonadIO m, IsAttachment o) => o -> m Attachment

Cast to Attachment, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, save, saveToCallback, saveToFd, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getChecksum, getCtime, getData, getDescription, getMtime, getName, getProperty, getQdata, getSize.

Setters

setData, setDataFull, setProperty.

getChecksum

attachmentGetChecksum

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m String

Returns: The attachment's checksum.

No description available in the introspection data.

Since: 20.09.0

getCtime

attachmentGetCtime

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m (Maybe DateTime)

Returns: The attachment's creation date and time as a DateTime, or Nothing if the creation date and time is not available.

No description available in the introspection data.

Since: 20.09.0

getDescription

attachmentGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m Text

Returns: The attachment's descriptive text.

No description available in the introspection data.

Since: 20.09.0

getMtime

attachmentGetMtime

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m (Maybe DateTime)

Returns: The attachment's modification date and time as a DateTime, or Nothing if the modification date and time is not available.

No description available in the introspection data.

Since: 20.09.0

getName

attachmentGetName

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m Text

Returns: The attachment's name.

No description available in the introspection data.

Since: 20.09.0

getSize

attachmentGetSize

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: a Attachment

-> m Word64

Returns: The attachment's size.

No description available in the introspection data.

Since: 20.09.0

save

attachmentSave

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: A Attachment.

-> Text

filename: name of file to save

-> m ()

(Can throw GError)

Saves attachment to a file indicated by filename. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.

saveToCallback

attachmentSaveToCallback

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: A Attachment.

-> FunPtr C_AttachmentSaveFunc

saveFunc: a function that is called to save each block of data that the save routine generates.

-> m ()

(Can throw GError)

Saves attachment by feeding the produced data to saveFunc. Can be used when you want to store the attachment to something other than a file, such as an in-memory buffer or a socket. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.

saveToFd

attachmentSaveToFd

Arguments

:: (HasCallStack, MonadIO m, IsAttachment a)

=> a

attachment: A Attachment.

-> Int32

fd: a valid file descriptor open for writing

-> m ()

(Can throw GError)

Saves attachment to a file referred to by fd. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates. Note that this function takes ownership of fd; you must not operate on it again, nor close it.

Since: 21.12.0